astronomy-commons/lsdb

Add a glossary of terms in the documentation

Offen

#949 geöffnet am 24.07.2025

Auf GitHub ansehen
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)Python (21 Forks)auto 404
documentationgood first issue

Repository-Metriken

Stars
 (54 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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.

Contributor Guide

Research-Richtung
Überprüfe die bestehende Dokumentationsstruktur, finde den passenden Ort für ein Glossar und erstelle eine Liste von Begriffen aus dem Code und der Dokumentation. Überlege, wie du Glossarbegriffe in bestehenden Seiten verlinken kannst, um die Benutzererfahrung zu verbessern.
Tech Stack
python
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80