NixOS/nix

Move examples in classic commands closer to the top

Ouverte

#10 717 ouverte le 14 mai 2024

Voir sur GitHubGuide contributeur
 (0 commentaire) (0 réaction) (0 personne assignée)C++ (1 293 forks)batch import
documentationgood first issue

Métriques du dépôt

Stars
 (9 803 étoiles)
Métriques de merge PR
 (Merge moyen 7j 11h) (83 PRs mergées en 30 j)

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.

Guide contributeur

Direction de recherche
Trouvez les fichiers sources du manuel dans le depot (probablement sous doc/manual/src), localisez les pages des commandes classiques et deplacez les blocs d'exemples du bas juste apres la section de description, en imitant la disposition des commandes experimentales.
Stack technique
Aucun
Domaine
developer experience
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90