NixOS/nix

Move examples in classic commands closer to the top

Open

#10.717 aperta il 14 mag 2024

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)C++ (1293 fork)batch import
documentationgood first issue

Metriche repository

Star
 (9803 star)
Metriche merge PR
 (Merge medio 4g 12h) (86 PR mergiate in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Individua le pagine di manuale dei comandi classici in doc/manual/src/command ref/. Rivedi la struttura delle pagine dei comandi sperimentali per vedere il posizionamento degli esempi. Sposta la sezione degli esempi immediatamente dopo la sezione di descrizione in ogni pagina di comando classico. Verifica la coerenza e che nessun riferimento sia interrotto.
Tech stack
Nessuno
Dominio
documentation
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Familiarity with Nix manual source structure
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80