NixOS/nix

Move examples in classic commands closer to the top

Aberta

#10.717 aberto em 14 de mai. de 2024

Ver no GitHubGuia do colaborador
 (0 comentário) (0 reação) (0 responsável)C++ (1.293 forks)batch import
documentationgood first issue

Métricas do repositório

Stars
 (9.803 estrelas)
Métricas de merge de PR
 (Mesclagem média 7d 11h) (83 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
Encontre os arquivos fonte do manual no repositório (provavelmente em doc/manual/src), localize as páginas de comandos clássicos e mova os blocos de exemplo da parte inferior para logo após a seção de descrição, espelhando o layout dos comandos experimentais.
Pilha de tecnologia
None
Domain
developer experience
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
1
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
Git
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
90