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

cleanup of old doc migration files #812

Description

@4ydan

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

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationenhancementNew feature or request

Type

No type

Fields

No fields configured for issues without a type.

Projects

Status
Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions