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

Documentation Request: Include subsection links in documentation sidebar #3031

Open
DanKaplanSES opened this issue Feb 4, 2024 · 1 comment
Labels

Comments

@DanKaplanSES
Copy link

For context, I was trying to learn the difference between = and |=. The sidebar includes Assignment but it does not include links to the subsection named Update assignment: |= or Plain assignment: =. Because another section divides these two, I had to scroll back and forth to read, and often went clicked on the wrong place by clicking on Advanced Features instead of "Assignment."

To put it another way, I would like another level of nesting for each section so, for example, there would be links for "Update assignment" and "Plain assignment" at this red line:

image

Environment (please complete the following information):

  • OS and Version: [e.g. macOS, Windows, Linux (please specify distro)]: Windows 10, WSL Ubuntu
  • jq version [e.g. 1.5]: 1.6
@itchyny itchyny added the docs label Feb 7, 2024
@wader
Copy link
Member

wader commented Feb 9, 2024

Had a quick look at adding a subsection for each entry for a section in the content tree. Ran into two issues:

  • Some section has quite a lot of entries, might make the table of contents quite long. Maybe could be solved by folding somehow? see below
  • Didn't find any clear way with bootstrap to generate a "tree" table of contents that still shows the "active" section when scrolling. Someone who knows bootstrap maybe knows how?

A possible other solution might be to move out some entries to become sections instead?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants