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

Improve in-page ToC #131

Open
eric-schneider opened this issue May 7, 2024 · 2 comments
Open

Improve in-page ToC #131

eric-schneider opened this issue May 7, 2024 · 2 comments
Labels
enhancement New feature or request P1

Comments

@eric-schneider
Copy link
Contributor

eric-schneider commented May 7, 2024

We should consider making some usability improvements to the in-page ToC (right-hand nav).

On width-constrained screens, we simply move the ToC to the top of the page. This means that if you land on a section in the middle of the page (either from xref or search) you won't even see the ToC, and using it requires you to scroll all the way back to the top. Also, since the ToC doesn't collapse, large ToCs take up a lot of real estate. We should consider better collapse behaviors that are more useful and take up less room.

We might also consider making visual improvements so that it's easier to identify which page section you're currently scrolling offer better support for third-level section headers.

@eric-schneider eric-schneider added enhancement New feature or request P1 labels May 7, 2024
@aimurphy
Copy link

aimurphy commented May 7, 2024

Adding on that when the miniTOC is at the top of the page, it should break & collapse at a certain point. Here's an example from Puppet docs that shows this behavior:
image

@aimurphy
Copy link

aimurphy commented May 7, 2024

Also, I am using a Dell U2719DX monitor, and I tend to keep my windows split 50/50 (chrome on one side, vscode on the other). I noticed that the miniTOC breaks to the top when the viewport is 1439px wide or less. My monitor is 2560px wide, so it's breaking to "tablet view" (for lack of a better term) before 50% width, which is what led me to believe that the miniTOC was permanently at the top of the page.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request P1
Projects
None yet
Development

No branches or pull requests

2 participants