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++ (1,293 forks)batch import
documentationgood first issue

Repository metrics

Stars
 (9,803 stars)
PR merge metrics
 (Avg merge 7d 11h) (83 merged PRs in 30d)

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

Research direction
Find all instances of `NIX PATH` in the manual source files and add hyperlinks to the central definition.
Tech stack
cpp
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitMarkdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85