astronomy-commons / astronomy-commons/lsdb
Add a glossary of terms in the documentation
Open
documentation
good first issue
- Dominant language
- Python
- Stars
- 55
- Forks
- 26
- Avg merge
- 4d 1h
- Merged PRs (30d)
- 8
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
No contributing guide indexed for this repository
Research direction
Start by reviewing the existing documentation and the jargon identified in the HCI study. Add a glossary page for unfamiliar terms, then consider linking those terms from their occurrences in the docs as the stretch goal. Done means the glossary is available and its coverage is clear.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100