diff --git a/.github/REFERENCE.md b/.github/REFERENCE.md deleted file mode 100644 index e69de29..0000000 diff --git a/resources/DOCS.md b/resources/DOCS.md index e69de29..05fd624 100644 --- a/resources/DOCS.md +++ b/resources/DOCS.md @@ -0,0 +1,11 @@ +# Documentation + + +### Highlights +`💥` - Disruptive + +`🌍` - Influential + +`🌟` - Pioneering + +`💡` - Innovative \ No newline at end of file diff --git a/resources/PORTAL.md b/resources/PORTAL.md index 007dee6..1d24abf 100644 --- a/resources/PORTAL.md +++ b/resources/PORTAL.md @@ -10,7 +10,22 @@ The place that connects everything related to definitive-opensource. [Selfhost](readmes/selfhost.md) ### Contributing +[CONTRIBUTING](.github/CONTRIBUTING.md) - Goes over how to contribute, conventions, etc +[GUIDELINES](.github/GUIDELINES.md) - Guidelines for what qualifies a project to be added ### Development +[ARCHITECTURE.md](resources/dev/ARCHITECTURE.md) - Explains the "backend" of the list +[source/scripts/generation](source/scripts/generation) - Contains scripts related to README generation +[source/scripts/maintenance](source/scripts/maintenance) - Contains scripts related to maintenance + +## Data +[applications.json](source/data/applications.json) - Stores all information related to applications +[categories.json](source/data/categories.json) - Declares categories and subcategories +[tags](source/data/tags.json) - Declares tags, their id, and corresponding emoji ## GitHub Actions +[generate-readme.yml](.github/workflows/generate-readme.yml) - Calls the [```readme_generator.py```](source/scripts/generation/readme_generator.py) to generate READMEs +[update-stats.yml](.github/workflows/update-stats.yml) - Calls the [```stats_updator.py```](source/scripts/maintenance/stats_updator.py.py) to update stats in applications.json + +## Other Resources +[DOCS.md](resources/DOCS.md) - Elaborates tags diff --git a/resources/dev/ARCHITECTURE.md b/resources/dev/ARCHITECTURE.md index 097ff57..4de5019 100644 --- a/resources/dev/ARCHITECTURE.md +++ b/resources/dev/ARCHITECTURE.md @@ -9,7 +9,7 @@ The generation scripts are inside of the [```source/scripts/generation```](sourc [```tableofcontents_generator.py```](source/scripts/generation/tableofcontents_generator.py) generates the table of contents. It creates one, expandable but hidden by default, with all subsections listed alphabetically. The default TOC shows parent categories alphabetically with subcategories underneath, also alphabetically. -```contents_generator.py```](source/scripts/generation/contents_generator.py) generates the actual list. +[```contents_generator.py```](source/scripts/generation/contents_generator.py) generates the actual list. Lastly [```readme_generator.py```](source/scripts/generation/readme_generator.py) brings everything together, calling the other scripts to generate one main list, and more for several platforms.