astronomy-commons/lsdb

Add a glossary of terms in the documentation

开放

#949 创建于 2025年7月24日

在 GitHub 查看
 (1 条评论) (0 个反应) (0 位负责人)Python (21 个派生)auto 404
documentationgood first issue

仓库指标

星标
 (54 个星标)
PR 合并指标
 (PR 指标待抓取)

描述

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.

贡献者指南

研究方向
查看现有文档结构，找出添加术语表的位置，并从代码库和文档中收集术语列表。考虑如何在现有页面中链接术语表术语以提升用户体验。
技术栈
python
领域
documentation
议题类型
文档
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 小时
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
Git
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
80