Maintenance: Adjust directory layout. Naming things. Modernize documentation. #61
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
In order to clean up a bit, firmwares have been grouped by origin. In this way, the repository can grow, but still everyone can feel at home, within their corresponding subdirectories. At the same time, benefits coming from shared CI and documentation infrastructure will be retained and even improved.
amotl
changed the title
amotl
changed the title
Merged
|
sphinx-design has been added to 1, using MyST, and sphinxcontrib-mermaid to 2. It looks so beautiful. Thank you all for your excellent work and keep up the spirit. /cc @chrisjsewell, @choldgraf, @jpmckinney, @mgaitan, @hugovk, @bastiedotorg Footnotes |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
About
Directory layout
In order to clean up a bit, firmwares have now been grouped into subfolders by origin. In this way, the repository can grow further, but still everyone can feel at home, within their corresponding subdirectories. At the same time, benefits coming from shared CI and documentation infrastructure will be retained and even improved.
Naming things
By adding subdirectories, we are now able to detour from the previous directory layout and naming scheme, which was very strict and not optimal on different aspects. Now, the naming scheme aims to be more attractive for human consumption. The most notable changes are:
openhive-gsm-wifiandopenhive-yun. /cc @ClemensGruber, @bee-moisgenericfirmware has been renamed tobackdoor/multihop. /cc @einsiedlerkrebsnode-homie-basic,node-homie-lowpower, andnode-homie-scale-adjust. /cc @Gulaschcowboynode-esp8266-genericandnode-esp32-generichave been renamed totrudering/bienenwaage-{2.0,5.0}. /cc @u-l-m-iModernize documentation