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