NixOS/nix

link to common options in command reference

Open

#7,143 opened on Oct 7, 2022

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

Repository metrics

Stars
 (9,803 stars)
PR merge metrics
 (Avg merge 4d 12h) (86 merged PRs in 30d)

Description

Problem

Users have trouble discovering options that apply to multiple commands. (I found multiple reports just this week.)

Checklist

Proposal

Add a line to each command which this applies to, e.g. here for nix-build.

Contributor guide

Research direction
Edit the command reference pages (e.g., doc/manual/src/command ref/nix build.md) to add a link to the common options page (opt common.html). Use the format shown in the Nix manual. Refer to the issue for exact location.
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.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
MarkdownNix documentation structure
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90