Skip to content
This repository has been archived by the owner on Apr 24, 2024. It is now read-only.

cleanup of old doc migration files #812

Closed
4ydan opened this issue Aug 8, 2023 · 5 comments
Closed

cleanup of old doc migration files #812

4ydan opened this issue Aug 8, 2023 · 5 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@4ydan
Copy link
Contributor

4ydan commented Aug 8, 2023

Problem

Currently when opening the Mdbook you get greeted with a Changelog.
Also the chapters on the left side are way too many.

The reference below has a sidebar that is barely scrollable.

Our book:
image

Example1:
https://rust-lang.github.io/mdBook/index.html
image

Example2: (a bigger left nav bar)
https://doc.rust-lang.org/nightly/reference/

Suggested Solution

  • Have an Introduction first page showing either a summary of what there is or duplicate the left side bar for better navigation
  • Dont show meeting subchapters
  • Dont allow 3 nesting levels (X.X.X is fine but not X.X.X.X)
  • Or Create multiple different books(Design, Development, Guidelines, Meetings, Use cases, etc.) each with ther own subpath and own nav bar on the left
  • Or split the book in frontend/backend/infrastructure for different teams
  • Or fold all chapters per default
@4ydan 4ydan added documentation Improvements or additions to documentation enhancement New feature or request labels Aug 8, 2023
@4ydan 4ydan changed the title Mdbook Mdbook first page + left side bar Aug 8, 2023
@4ydan
Copy link
Contributor Author

4ydan commented Aug 8, 2023

There are also blank pages
image
image

@markus2330
Copy link
Contributor

markus2330 commented Aug 9, 2023

Thank you for creating the issue!

Currently when opening the Mdbook you get greeted with a Changelog.

Why is C ordered before a? Maybe we rename CHANGELOG.md to changelog.md?

Dont show meeting subchapters

I think we can simply remove all old meetings.

Or Create multiple different books(Design, Development, Guidelines, Meetings, Use cases, etc.) each with ther own subpath and own nav bar on the left

I am afraid this will lead to even more duplication and problems where to put what.

Or split the book in frontend/backend/infrastructure for different teams

We already have separate documentation for frontend (storybook), backend (API docu) and infrastructure (private repo). 😉

Or fold all chapters per default

This is an excellent idea. Do you know how to do it?

@markus2330
Copy link
Contributor

There are also blank pages

I hope @temmey can clean them up now after we implemented the hierarchy. (Then we don't need these example migrations anymore).

@4ydan
Copy link
Contributor Author

4ydan commented Aug 9, 2023

This is an excellent idea. Do you know how to do it?

Dont know, can have a look.

@temmey
Copy link
Contributor

temmey commented Aug 11, 2023

There are also blank pages

I hope @temmey can clean them up now after we implemented the hierarchy. (Then we don't need these example migrations anymore).

will be done in #793

4ydan added a commit that referenced this issue Aug 14, 2023
@markus2330 markus2330 added needed later currently closed but might be needed later and removed needed later currently closed but might be needed later labels Aug 26, 2023
@markus2330 markus2330 changed the title Mdbook first page + left side bar cleanup of old doc migration files Aug 26, 2023
@markus2330 markus2330 moved this to Current Milestone in PermaplanT Aug 26, 2023
@github-project-automation github-project-automation bot moved this from Current Milestone to Done in PermaplanT Mar 30, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
Archived in project
Development

No branches or pull requests

3 participants