diff --git a/resources/DOCS.md b/resources/DOCS.md index 05fd624..a291027 100644 --- a/resources/DOCS.md +++ b/resources/DOCS.md @@ -2,10 +2,13 @@ ### Highlights -`💥` - Disruptive +`💥` - Disruptive: For apps that are introducing something revolutionary that could "disrupt" the market. -`🌍` - Influential +`🌍` - Influential: An established product that has shaped or continues to hold influence in the world -`🌟` - Pioneering +`🌟` - Pioneering: Something that is leading the way in a new field -`💡` - Innovative \ No newline at end of file +`💡` - Innovative: Projects that "invent" something new + +### Flags +`custom-description` - For apps whose description is not from GitHub so that the `stats_updator.py` script skips updating it \ No newline at end of file diff --git a/resources/PORTAL.md b/resources/PORTAL.md index b354dc5..942a499 100644 --- a/resources/PORTAL.md +++ b/resources/PORTAL.md @@ -24,8 +24,8 @@ The place that connects everything related to definitive-opensource. - [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 +- [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 4de5019..b24af34 100644 --- a/resources/dev/ARCHITECTURE.md +++ b/resources/dev/ARCHITECTURE.md @@ -3,15 +3,15 @@ Here's a look at how the "backend" of the list works. ## README Generation -All applications are stored inside [```applications.json```](source/data/applications.json). Categories are declared inside [```categories.json```](source/data/categories.json). Instead of a nested format with subcategories as on object of it's parent, we've given subcategories a ```parent``` attribute. There's also a [```tags.json```](source/data/tags.json). Instead of putting the emoji inside of the ```tags``` attribute in ```applications.json```, the id is used, for example, ```commercial``` or ```disruptive```.. These id's are mapped to their corresponding emoji for when the READMEs are generated and makes ```applications.json``` more readable. +All applications are stored inside [`applications.json`](source/data/applications.json). Categories are declared inside [`categories.json`](source/data/categories.json). Instead of a nested format with subcategories as on object of it's parent, we've given subcategories a `parent` attribute. There's also a [`tags.json`](source/data/tags.json). Instead of putting the emoji inside of the ```tags``` attribute in `applications.json`, the id is used, for example, `commercial` or `disruptive`.. These id's are mapped to their corresponding emoji for when the READMEs are generated and makes``applications.json``` more readable. -The generation scripts are inside of the [```source/scripts/generation```](source/scripts/generation) directory. [```mainheader_generator.py```](source/scripts/generation/mainheader_generator.py) generates the very top header with the dynamic project count. Then, depending on the platform being generating, it inserts [```header.md```](source/components/header.md), [```macosheader.md```](source/components/macosheader.md), etc. [ +The generation scripts are inside of the [`source/scripts/generation`](source/scripts/generation) directory. [`mainheader_generator.py`](source/scripts/generation/mainheader_generator.py) generates the very top header with the dynamic project count. Then, depending on the platform being generating, it inserts [`header.md`](source/components/header.md), [`macosheader.md`](source/components/macosheader.md), etc. -[```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. +[`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. +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. ## Maintenence -[```applications.json```](source/data/applications.json) stores a lot of information that the README does not display such as last commit, language, and license. These are for a future web version of the list that would pull data from the json file. [```stats_updator.py```](source/maintenance/stats_updator.py) runs every midnight and updates all application stats. Each application object in the json file also has a ```flags``` attribute. For example, the ```custom-description``` flag tells the stats_updator script to skip updating the description for that app. For more into on flags, consult the [```DOCS.md```](resources/DOCS.md) \ No newline at end of file +[`applications.json`](source/data/applications.json) stores a lot of information that the README does not display such as last commit, language, and license. These are for a future web version of the list that would pull data from the json file. [`stats_updator.py`](source/maintenance/stats_updator.py) runs every midnight and updates all application stats. Each application object in the json file also has a `flags` attribute. For example, the `custom-description` flag tells the stats_updator script to skip updating the description for that app. For more into on flags, consult the [`DOCS.md`](resources/DOCS.md) \ No newline at end of file