starred/definitive-opensource-mustbeperfect
1
0
Fork 0
mirror of https://github.com/mustbeperfect/definitive-opensource.git synced 2026-04-17 15:43:26 +02:00
Code Issues Packages Projects Releases Wiki Activity

Added to PORTAL.md and replaced REFERENCE.md with DOCS.md

Browse Source
This commit is contained in:
Lucas
2025-04-10 08:39:07 -07:00
parent b99f41d920
commit 31996c54c5
4 changed files with 27 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

0
.github/REFERENCE.md vendored
View File

11
resources/DOCS.md
View File

@@ -0,0 +1,11 @@
# Documentation
### Highlights
`💥` - Disruptive
`🌍` - Influential
`🌟` - Pioneering
`💡` - Innovative

15
resources/PORTAL.md
View File

@@ -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

2
resources/dev/ARCHITECTURE.md
View File

@@ -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.