NixOS/nix

manual: link occurrences of `NIX_PATH` to its definition

Open

#7,142 opened on Oct 7, 2022

View on GitHub
 (0 comments) (0 reactions) (0 assignees)C++ (9,803 stars) (1,293 forks)batch import
documentationgood first issue

Description

Problem

Investigating #7119 showed that definitions are not easily discoverable, although most information on how search paths work is actually in the manual, somewhere.

Checklist

Proposal

Link occurrences of NIX_PATH (e.g. in documentation of the -I option) to the central definition.

Contributor guide

Tech stack
None
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Markdownfamiliarity with Nix manual structure
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
Find all occurrences of `NIX PATH` in the Nix manual source files under `doc/manual/src/`. For each occurrence, add a hyperlink pointing to the central definition at `env common.html#env NIX PATH`. The manual uses Markdown, so links can be added using standard Markdown link syntax. Check that the links work correctly after building the manual.