NixOS/nix

Move examples in classic commands closer to the top

Open

#10,717 opened on May 14, 2024

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

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

Research direction
Find the manual source files in the repository (likely under doc/manual/src), locate the classic command pages, and move the example blocks from the bottom to right after the description section, mirroring the layout of experimental commands.
Tech stack
None
Domain
developer experience
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
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90