-
Notifications
You must be signed in to change notification settings - Fork 7
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Restructure the home page into a user guide #193
Merged
Merged
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
llucax
added
part:docs
Affects the documentation
type:enhancement
New feature or enhancement visitble to users
labels
Dec 7, 2023
Made a draft because it is based on: |
github-actions
bot
added
part:cookiecutter
Affects the generation of projects using cookiecutter
and removed
part:docs
Affects the documentation
labels
Dec 7, 2023
github-actions
bot
removed
the
part:cookiecutter
Affects the generation of projects using cookiecutter
label
Dec 7, 2023
This commit split the `docs/index.md` file, that grew quite significantly, into a more organized user guide top-level section. The content is the same, it is just reorganized. To make the new user guide sub-sections more visible we now configure mkdocs to automatically expand the navigation bar. Signed-off-by: Leandro Lucarella <[email protected]>
Signed-off-by: Leandro Lucarella <[email protected]>
#192 merged, updating, so ready for review. |
llucax
requested review from
matthias-wende-frequenz and
daniel-zullo-frequenz
December 8, 2023 14:45
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I only have an optional cosmetic comment. LGTM
Co-authored-by: daniel-zullo-frequenz <[email protected]> Signed-off-by: Leandro Lucarella <[email protected]>
Accepted the suggestion, will merge. |
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 commit split the
docs/index.md
file, that grew quite significantly, into a more organized user guide top-level section.The content is the same, it is just reorganized.
To make the new user guide sub-sections more visible we now configure mkdocs to automatically expand the navigation bar.