Skip to content
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 3 commits into from
Dec 8, 2023

Conversation

llucax
Copy link
Contributor

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

@llucax llucax requested a review from a team as a code owner December 7, 2023 11:14
@llucax llucax marked this pull request as draft December 7, 2023 11:14
@llucax llucax removed the request for review from matthias-wende-frequenz December 7, 2023 11:14
@llucax llucax self-assigned this Dec 7, 2023
@llucax llucax added part:docs Affects the documentation type:enhancement New feature or enhancement visitble to users labels Dec 7, 2023
@llucax llucax added this to the v0.8.0 milestone Dec 7, 2023
@llucax
Copy link
Contributor Author

llucax commented Dec 7, 2023

@github-actions 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 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]>
@llucax llucax marked this pull request as ready for review December 8, 2023 14:44
@llucax
Copy link
Contributor Author

llucax commented Dec 8, 2023

#192 merged, updating, so ready for review.

Copy link
Contributor

@daniel-zullo-frequenz daniel-zullo-frequenz left a 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]>
@llucax
Copy link
Contributor Author

llucax commented Dec 8, 2023

Accepted the suggestion, will merge.

@llucax llucax disabled auto-merge December 8, 2023 20:37
@llucax llucax merged commit f615832 into frequenz-floss:v0.x.x Dec 8, 2023
14 checks passed
@llucax llucax deleted the user-guide branch December 8, 2023 20:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:enhancement New feature or enhancement visitble to users
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants