NixOS / NixOS/nix.dev

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

Open
#873 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

site
Dominant language
Nix
Stars
4k
Forks
339
Avg merge
2d 11h
Merged PRs (30d)
7

Description

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.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no files, tests, or entry points to inspect. Begin by locating the documentation navigation implementation and comparing the sidebar and breadcrumb approaches; done means users can move from a deeply nested page to its broader sections, including on mobile.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.