NixOS/nix

Move examples in classic commands closer to the top

Aperta

#10.717 aperta il 14 mag 2024

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

Metriche repository

Star
 (9803 stelle)
Metriche merge PR
 (Merge medio 7g 11h) (83 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
Trova i file sorgente del manuale nel repository (probabilmente sotto doc/manual/src), individua le pagine dei comandi classici e sposta i blocchi di esempio dalla parte inferiore subito dopo la sezione di descrizione, seguendo il layout dei comandi sperimentali.
Tech stack
Nessuno
Dominio
developer experience
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
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
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
90