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

Navigation doesn't keep track of your position in the hierarchy #873

Open
lf- opened this issue Jan 27, 2024 · 1 comment
Open

Navigation doesn't keep track of your position in the hierarchy #873

lf- opened this issue Jan 27, 2024 · 1 comment
Labels
site Improvements to the site infrastructure or content presentation

Comments

@lf-
Copy link
Member

lf- commented Jan 27, 2024

Observations

I click on concepts then flakes then "why should i enable flakes" from the home page. I open the sidebar on mobile. I expect to be able to navigate up in the hierarchy somehow.

Problem

Currently if you're in a specific section in the docs, you can't easily go up in the logical hierarchy to a more general section.

I had a related beef with not being able to choose Nix reference manual versions by deleting URL components which I probably filed somewhere else also.

Approaches

The way mdbook seems to do it, you can open the sidebar and the current page is highlighted. Similarly in okular while viewing pdfs. This requires a sidebar that shows every section though, and might be a bit far into paper metaphor (e.g. what order things appear in is a very book thing ported onto to a hypertext system).

Another thing we could do is breadcrumbs in the top of the page somewhere like docs.python.org (though most of the time I would consider that site a counterexample of usability). Evidently Sphinx supports it.

Willing to help?

Perhaps.

Priorities

Add 👍 to issues you find important.

@lf- lf- added the site Improvements to the site infrastructure or content presentation label Jan 27, 2024
@fricklerhandwerk
Copy link
Collaborator

The way mdbook seems to do it, you can open the sidebar and the current page is highlighted. [...] This requires a sidebar that shows every section though

This is what Sphinx does as well. There is a right side bar for the sections.

PS: Sphinx is not great, but mdBook is definitely worse. I tried customising both, and... no. I'd rather write my own framework than trying to do something that the authors didn't consider for these tools.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
site Improvements to the site infrastructure or content presentation
Projects
None yet
Development

No branches or pull requests

2 participants