kubermatic / kubermatic/docs

Menu Navigation - Collapse All Option

Open
#1,202 10 comments 0 reactions 0 assignees View on GitHub
lifecycle/frozen
Dominant language
SCSS
Stars
19
Forks
117
Avg merge
13h 29m
Merged PRs (30d)
13

Description

Currently, it's hard for doc users to find some detailed subpages where the name potential is unknown. E.g. if I search the OS compatibility matrix, I would need to know that the site is placed under `Tutorials & How-tos > Operating System Manager > Compatibility Matrix`.
![Compatibility Matrix - KKP Documentation 2022-09-01 12-08-44](https://user-images.githubusercontent.com/4659261/187892689-9f4fbac9-2c03-4a2d-aab0-3b98bd5d870f.png)

As every user maybe expect this information at another location, we should give the user an easier option to give them an overview about all existing content. For this, a "Collapse All" menu item Button could help to scan the items quicker, as I don't need to collapse every single item.

Another option would be to have an index page, where all content item's menu is displayed in a tree structure.

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the current documentation menu described in the issue and determine whether a "Collapse All" control or a tree-style index best addresses navigation. Done means users can quickly view or scan all existing documentation content without manually collapsing each menu section.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.