NixOS/nix

Move examples in classic commands closer to the top

Open

#10.717 geöffnet am 14. Mai 2024

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)C++ (1.293 Forks)batch import
documentationgood first issue

Repository-Metriken

Stars
 (9.803 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 4T 12h) (86 gemergte PRs in 30 T)

Beschreibung

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-Richtung
Finde die Handbuchseiten der klassischen Befehle in doc/manual/src/command ref/. Überprüfe die Struktur der experimentellen Befehlsseiten, um die Platzierung der Beispiele zu sehen. Verschiebe den Beispielabschnitt direkt nach dem Beschreibungsabschnitt auf jeder klassischen Befehlsseite. Überprüfe die Konsistenz und stelle sicher, dass keine Referenzen kaputt sind.
Tech Stack
Keine
Domain
documentation
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Familiarity with Nix manual source structure
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80