NixOS / NixOS/nix.dev

Insufficient links between guide and reference level docs makes splitting challenging

Open
#840 1 comment 1 reaction 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 there are efforts to split docs into guide vs reference level materials and this is likely great but the reference level docs no longer are next to the relevant guides. We need more deep links between nixpkgs and nix docs and nix.dev guide level materials.

related discussion https://logs.nixos.dev/room/!avYyleMexqjFHoqrME:nixos.org/?anchor=$1a-p0jIFGfppHqFadSnQIpoX40mUALH9qt7griX9qWk&offset=-10

Problem

Hard to get between high level overview (do we even have these materials? like a map between Nix concepts and how they're used in nixpkgs if at all), reference, and guides, especially starting at reference. It's true that Nix shouldn't assume nixpkgs (bull is out of the pen on that one in many cases code wise) but we should link to how nixpkgs uses each high level concept.

Approaches

Add more links and maybe write in the style guide where links are appropriate and how to integrate them.

Willing to help?

yeah

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 by reviewing the guide- and reference-level materials in nix.dev, along with the related Nix and nixpkgs documentation, to map where navigation is missing. Done means the relevant concepts have links between guides, reference pages, and nixpkgs usage, with any linking guidance captured in the style guide.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.