NixOS/nix

Move examples in classic commands closer to the top

Open

#10717 opened on May 14, 2024

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

Description

Problem

Command line examples for classic commands are at the very bottom of each manual page, which makes them hard to discover after reams of generic options.

Proposal

Move them right after the description, as with the experimental commands.

Checklist

Priorities

Add :+1: to issues you find important.

Contributor guide

Tech stack
None
Domain
documentation
Issue type
feature
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.
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
Familiarity with Nix manual source structure
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
Locate classic command manual pages in doc/manual/src/command ref/. Review the structure of experimental command pages to see the placement of examples. Move the examples section immediately after the description section in each classic command page. Verify consistency and that no references are broken.