NixOS/nix

Move examples in classic commands closer to the top

Open

#10 717 ouverte le 14 mai 2024

Voir sur GitHub
 (0 commentaires) (0 réactions) (0 assignés)C++ (1 293 forks)batch import
documentationgood first issue

Métriques du dépôt

Stars
 (9 803 stars)
Métriques de merge PR
 (Merge moyen 4j 12h) (86 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
Localisez les pages de manuel des commandes classiques dans doc/manual/src/command ref/. Examinez la structure des pages de commandes expérimentales pour voir le placement des exemples. Déplacez la section des exemples immédiatement après la section de description dans chaque page de commande classique. Vérifiez la cohérence et assurez vous qu'aucune référence n'est cassée.
Stack technique
Aucun
Domaine
documentation
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
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
Familiarity with Nix manual source structure
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80