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

Subsubsubsection visibility. #236

Open
nomeata opened this issue Jan 8, 2025 · 1 comment
Open

Subsubsubsection visibility. #236

nomeata opened this issue Jan 8, 2025 · 1 comment

Comments

@nomeata
Copy link
Collaborator

nomeata commented Jan 8, 2025

I have a sense that currently the handling where different depths of sections are visible is inconsistent, especially with regard to forth-level sections.

The main page cuts off at the second level. So if I am interested in structural recursion, I probably click on the second-level header “recursive definitions”. I now have on the left the third-level sections, good to get an overview. At the top of the main section I do not have a toc. So I nowhere see the third-level sections headers, which I believe would be useful for me to get a sense of what’s there.

Especially curious: If I now go “up”, to “4. Source Files”, I see in the main view a nice deep TOC for that section.

Possible changes that would likely find useful:

  • At the top of “4.4. Recursive Definitions”, include a detailed TOC for that section. Make that a rule: The top of every file should have a TOC that that goes as at least deep as the the sections that are directly in that file.

  • Somehow show nested sections on the left. I could image that below the toggleable “4. Source Files” and the toggleable “4.4. Recursive definitions” to have similar sections “4.4.1 Structural Recursion” etc. Maybe all un-toggled by default.

@david-christiansen
Copy link
Collaborator

Both of these changes are good, thanks!

It's quick and easy to add the local page's ToC to the top. I'll have to check a bit and see where it should go - if it's before the text, that might be jarring, but if it's after the introductory paragraph but before any subsections, it might get in the way.

The plan is to have the left sidebar get an additional list below the document navigation, which is "things on this page". This would include all section headers, but also the names documented on the page and perhaps also examples. I think this matches your second suggestion as well. I plan to make it linear rather than hierarchical, and rely on the section numbering and typography to communicate the levels. I think that matches your second suggestion pretty well, right?

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

No branches or pull requests

2 participants