astronomy-commons/lsdb

Add a glossary of terms in the documentation

Ouverte

#949 ouverte le 24 juil. 2025

Voir sur GitHub
 (1 commentaire) (0 réaction) (0 personne assignée)Python (21 forks)auto 404
documentationgood first issue

Métriques du dépôt

Stars
 (54 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

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.

Guide contributeur

Direction de recherche
Examinez la structure de documentation existante, trouvez l'emplacement approprié pour un glossaire et dressez une liste de termes à partir du code et de la documentation. Réfléchissez à la manière de lier les termes du glossaire dans les pages existantes pour améliorer l'expérience utilisateur.
Stack technique
python
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80