Adding a glossary at the end of tutorials
まだ誰も着手していません。
評価
- 難易度
- 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
- スター
- 90
- フォーク
- 122
- 平均マージ
- 1時間 43分
- マージ済み PR（30日）
- 3
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
processing/processing-website のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
processing/processing-website#716 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
processing/processing-website#703 ·
-
Good First Issue Help Wanted Reference
難易度 1/5 1時間未満 初心者へのやさしさ 90/100
processing/processing-website#698 · コメント 5 件 · リアクション 1 件 ·
-
難易度 1/5 1時間未満 初心者へのやさしさ 72/100
processing/processing-website#681 · コメント 2 件 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
processing/processing-website#646 · コメント 3 件 ·
processing/processing-website の issue をすべて見る
似ている issue
-
feedback simulation workshop
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
githubnext/gh-aw-workshop#3687 ·
-
難易度 1/5 1時間未満 初心者へのやさしさ 62/100
-
curation good first issue
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
amponce/archive-movie-browser#186 ·
-
approved author-page correction
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
acl-org/acl-anthology#10042 · コメント 1 件 ·
-
check:passed streams:add
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100