astronomy-commons/lsdb

Add a glossary of terms in the documentation

Aberta

#949 aberto em 24 de jul. de 2025

Ver no GitHub
 (1 comentário) (0 reação) (0 responsável)Python (21 forks)auto 404
documentationgood first issue

Métricas do repositório

Stars
 (54 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

Description

One pain point brought up from the HCI study was that users were not familiar with the jargon. A suggestion was to add a glossary page in the docs. As a stretch goal, having the terms link to the glossary when they appear in the docs would be a good UX.

Guia do colaborador

Direção de pesquisa
Revise a estrutura da documentação existente, localize o local apropriado para um glossário e compile uma lista de termos do código e da documentação. Considere como vincular os termos do glossário nas páginas existentes para melhorar a experiência do usuário.
Pilha de tecnologia
python
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.
80