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

Expandable and collapsible headings and a content overview #665

Closed
Alagts opened this issue Jul 23, 2024 · 0 comments · Fixed by #820
Closed

Expandable and collapsible headings and a content overview #665

Alagts opened this issue Jul 23, 2024 · 0 comments · Fixed by #820
Assignees
Labels
accessibility enhancement New feature or request help wanted Extra attention is needed

Comments

@Alagts
Copy link

Alagts commented Jul 23, 2024

Overview:

Each page should ideally have a small content overview (headlines of the page) representing the overall structure of the page.
Every of these points/headlines should link to the actual article with corresponding headline on that page. In the content overview there should be a toggle to expand all existing sections again to revert all headline states again. At the beginning when accessing the page all sections should be expanded by default.

Main functionality:

Each headline should be collapsible. When a headline (for example H2) is collapsed all headlines in it that are smaller than the collapsed headline (for example H3) should be invisible until the documentation reader expands the same headline (H2) again.

Main benefits:

  • accessibility
  • improves readability
  • gives the opportunity to focus on the topics of interest
@Alagts Alagts added documentation Improvements or additions to documentation enhancement New feature or request accessibility help wanted Extra attention is needed and removed documentation Improvements or additions to documentation labels Jul 23, 2024
@Alagts Alagts self-assigned this Jul 23, 2024
@linawolf linawolf assigned Tim-Obert and unassigned Alagts Nov 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
accessibility enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants