NixOS / NixOS/nix.dev

Version selector for Nix manual in title bar

Open
#836 2 comments 3 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

Currently the Nix docs as seen here don't have the version number switchable and don't raise that you're not looking at the latest: https://nix.dev/reference/nix-manual

Problem

It's hard to navigate between Nix versions docs without knowing what the latest Nix version is.

Approaches

Consider docs.rs or docs.python.org as examples of the solution: there's a drop down in a top bar to select the version and on docs.rs there's a little warning if it's an old version.

This versioning thing could probably be reused for NixOS docs and such.

Willing to help?

Maybe

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

Start at the Nix manual page at https://nix.dev/reference/nix-manual and inspect how the title bar and documentation versions are presented. Compare the version-selection and outdated-version warnings on docs.rs or docs.python.org. Done means readers can select Nix manual versions and can tell when they are viewing an older version; consider whether the approach can be reused for NixOS documentation.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.