NixOS/nix

Move examples in classic commands closer to the top

Open

#10.717 aberto em 14 de mai. de 2024

Ver no GitHub
 (0 comments) (0 reactions) (0 assignees)C++ (1.293 forks)batch import
documentationgood first issue

Métricas do repositório

Stars
 (9.803 stars)
Métricas de merge de PR
 (Mesclagem média 4d 12h) (86 fundiu PRs em 30d)

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.

Guia do colaborador

Direção de pesquisa
Localize as páginas de manual dos comandos clássicos em doc/manual/src/command ref/. Revise a estrutura das páginas de comandos experimentais para ver a colocação dos exemplos. Mova a seção de exemplos imediatamente após a seção de descrição em cada página de comando clássico. Verifique a consistência e que nenhuma referência esteja quebrada.
Pilha de tecnologia
None
Domain
documentation
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Menos de 1 hora
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Recente
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Familiarity with Nix manual source structure
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
80