crickets-and-comb/shared

Differentiate documentation between `shared` and `reference_package`.

Open

#48 aberto em 26 de mar. de 2025

Ver no GitHub
 (0 comments) (0 reactions) (0 assignees)Makefile (0 forks)auto 404
documentationhelp wanted

Métricas do repositório

Stars
 (2 stars)
Métricas de merge de PR
 (Métricas PR pendentes)

Description

The README docs in the shared repo and the reference_package repo overlap quite a bit. Also, we abandoned updating documentation in reference_package where it pertains to shared procedures etc., so it has gotten stale.

We need to better differentiate the documentation in shared from the documentation in reference_package. The reference_package documentation shouldn't really document how to use the shared Git submodule other than to refer the user to the shared documentation.

See https://github.com/crickets-and-comb/reference_package/issues/21

Guia do colaborador

Direção de pesquisa
Compare os arquivos README nos repositórios 'shared' e 'reference package' para identificar conteúdo sobreposto. Em seguida, refine a documentação do 'shared' para focar em seus próprios recursos e garanta que a documentação do 'reference package' apenas se refira ao 'shared' sem duplicar instruções. Consulte a issue #21 do reference package para contexto.
Pilha de tecnologia
None
Domain
documentation
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.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
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.
75