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

Config options missing from TOC #207

Open
SeanBryan51 opened this issue Nov 20, 2023 · 0 comments
Open

Config options missing from TOC #207

SeanBryan51 opened this issue Nov 20, 2023 · 0 comments
Labels
priority:medium Medium priority issues to become high priority issues after a release.

Comments

@SeanBryan51
Copy link
Collaborator

Not all config options are accessible in the table of contents for the documentation of config options. It looks like only headings will be rendered in the table of contents and options documented using custom links will not be included.

I was thinking we could organise the options to use a flat structure and use the data-toc-label to make hierarchical options clear in the table of contents. The flat structure also gives a consistent look for all the yaml options.

@SeanBryan51 SeanBryan51 changed the title Use flat structure in documentation of config options Config options missing from TOC Nov 26, 2023
@ccarouge ccarouge added the priority:medium Medium priority issues to become high priority issues after a release. label May 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority:medium Medium priority issues to become high priority issues after a release.
Projects
None yet
Development

No branches or pull requests

2 participants