astronomy-commons/lsdb

Add a glossary of terms in the documentation

Aperta

#949 aperta il 24 lug 2025

Vedi su GitHub
 (1 commento) (0 reazioni) (0 assegnatari)Python (21 fork)auto 404
documentationgood first issue

Metriche repository

Star
 (54 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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.

Guida contributor

Direzione di ricerca
Esamina la struttura della documentazione esistente, individua il punto appropriato per un glossario e raccogli un elenco di termini dal codice e dalla documentazione. Considera come collegare i termini del glossario nelle pagine esistenti per migliorare l'esperienza utente.
Tech stack
python
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80