astronomy-commons/lsdb

Add a glossary of terms in the documentation

Open

#949 opened on Jul 24, 2025

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Python (21 forks)auto 404
documentationgood first issue

Repository metrics

Stars
 (54 stars)
PR merge metrics
 (PR metrics pending)

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.

Contributor guide

Research direction
Review the existing documentation structure, locate the appropriate place for a glossary, and compile a list of terms from the codebase and docs. Consider how to link glossary terms in existing pages for better UX.
Tech stack
python
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80