restyling 2024#157
Merged
digitigrafo merged 1 commit intolibremesh:masterfrom Feb 25, 2024
Merged
Conversation
Member
|
Awesome!!!!! The documentation from the packages is a greeeat new feature!! In the title you wrote that this is a draft. Can we merge or should we wait? |
7caaaa5 to
438558a
Compare
Contributor
Author
Thanks for this! I will look at it again I did these changes:
It is now 99% mergeable, I'll give it one last review soon and then ping |
438558a to
382d069
Compare
382d069 to
11af771
Compare
|
This is a big improvement for the usability of our website! thanks -agave |
Member
|
Beautiful, thanks!!!! |
This file contains hidden or 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
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.
This introduces a new theme similar to material for mkdocs
This also follows the discussion of the last few meetings at https://lists.autistici.org/message/20240107.174212.f777433f.en.html
The preview of the site is visible at:
https://libremesh.antennine.campiinrete.org/
Since the last preview, I made these changes, reviewed also by @digitigrafo:
lime-exampleand for each lime-packages, to have them also on the website (this shows at least theMakefile- that often contains a meaningful description - and if available it includes also theReadme.md)Currently, and as before, only pages that are directly contained in the
/docs/folder (depth: 1) are copied to firmware images for offline documentation (when selecting the packagelime-docsduring building)New pages should be added manually in the file
_data/structure.ymlto be visible also in the left menu.I hope that this theme and the ability to expand menu items, may lead to an expansion of the documentation and an increased clarity, while keeping a concise approach possible to avoid unnecessarily burdening the firmware images.