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

[Feature][Docs] Add "collapsible" (true/false) attribute to section config #5210

Open
hkosova opened this issue Nov 19, 2024 · 0 comments
Open

Comments

@hkosova
Copy link

hkosova commented Nov 19, 2024

Problem description

Section config in docs.yml currently supports the collapsed attribute which is very useful to manage large TOCs.

It would be great to also have the collapsible attribute so that we could create collapsible sections that are expanded by default.

Why would it be useful?

  • More consistent UX for sections - even if some sections are expanded by default, they can still be collapsed.
  • Feature parity with other documentation tools (e.g. Docusaurus).

Describe the solution (optional)

  • Sections have a boolean collapsible attribute.
  • Default value can be false to keep the current default UX.

Additional context

Screenshot 2024-11-19 at 13 11 12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

1 participant