Adding a glossary at the end of tutorials
維護者通常 1 天內回覆
還沒有人認領這個 Issue。
評估
- 難度
- 3/5
- 預估耗時
- 1-2 天
- 新手友好度
- 68/100
- Issue 類型
- 文件
- 描述清晰度
- 基本清楚
- 活躍度
- 冷清
- 技術堆疊
- markdown
- 領域
- content, documentation
研究方向
首先開啟 issue 中連結的 Color 和 Objects 教學,並搭配其目前的結構檢視隨附的 Glossary Examples PDF。為所參照的文字教學新增一致的詞彙表區段,包含關鍵術語與定義,讓使用者能在每個教學的結尾輕鬆找到這些術語。
由索引模型根據 Issue 內容生成。
描述
Which area of the website does this enhancement relate to?
Processing's text tutorials
Describe the enhancement
At the end of the tutorials on the Processing website, there could be a glossary at the end with key words of the tutorial and definitions for easy reference.
Why is this enhancement important?
When I was looking through them, I noticed there was lots of jargon scattered throughout the tutorials and not all of them were clearly defined (or were in a different linked page). For beginners, this might get confusing and they might spend a while going back and reading through the tutorial to figure out what words mean, so I thought a
glossary section would help.
The current format has some words linked to a different page. While this is useful, it can be inconvenient since it involves extra navigation of pages (and can get disorganized if the user opens them in another tab). This would keep key terms in a centralized, consistent location for each tutorial for quick referencing, which is especially in scenarios where a user has to go back to a previous tutorial to refresh their memory.
Additional context
The PDF includes example glossaries I wrote for the two text tutorials linked below.
- 主要語言
- MDX
- 星號
- 91
- 分支
- 121
- 平均合併
- 1 小時 20 分鐘
- 30 天內合併 PR
- 4
環境準備
這個專案沒有提供開發容器、Dockerfile 或貢獻指南,環境需要你自己搭建:先看它的 README,通用步驟見我們的新手貢獻指南。
從這裡開始
- 先讀完整個 Issue,再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫,在一個分支上完成修改。
- 送出 Pull Request,並在描述裡引用這個 Issue 編號。
processing/processing-website 的其他 Issue
-
難度 2/5 1-3 小時 新手友好度 76/100
processing/processing-website#716 ·
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 68/100
processing/processing-website#703 ·
維護者通常 1 天內回覆
-
Good First Issue Help Wanted Reference
難度 1/5 1 小時以內 新手友好度 90/100
processing/processing-website#698 · 5 則留言 · 1 個 reaction ·
維護者通常 1 天內回覆
-
難度 1/5 1 小時以內 新手友好度 72/100
processing/processing-website#681 · 2 則留言 ·
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 65/100
processing/processing-website#646 · 3 則留言 ·
維護者通常 1 天內回覆
查看 processing/processing-website 的全部 Issue
相似的 Issue
-
難度 2/5 1-3 小時 新手友好度 72/100
1c7/chinese-independent-developer#1449 ·
維護者通常 1 天內回覆
-
難度 1/5 1 小時以內 新手友好度 70/100
iptv-org/awesome-iptv#823 ·
-
www.vlast.is未關閉N: AdGuard for Windows P4: Low T: Annoyance
難度 2/5 1-3 小時 新手友好度 72/100
AdguardTeam/AdguardFilters#243266 ·
維護者通常 1 天內回覆
-
Sign the pledge未關閉
難度 1/5 1 小時以內 新手友好度 95/100
input-output-hk/devx-updates#163 ·
-
community first-timers-only good first issue hacktoberfest help wanted low hanging fruit up-for-grabs
難度 1/5 1 小時以內 新手友好度 95/100
lingdojo/kana-dojo#31515 · 1 則留言 · 5 個 reaction ·
維護者通常 1 天內回覆