processing / processing/processing-website
Adding a glossary at the end of tutorials
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- MDX
- Sterne
- 90
- Forks
- 122
- Ø Merge
- 1 Std. 43 Min.
- Gemergte PRs (30 T.)
- 3
Beschreibung
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.
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne damit, die im Issue verlinkten Tutorials zu Color und Objects zu öffnen und das beigefügte Glossary Examples PDF zusammen mit ihrer aktuellen Struktur zu prüfen. Füge den referenzierten Text-Tutorials einen konsistenten Glossarabschnitt mit Schlüsselbegriffen und Definitionen hinzu, wobei die Begriffe am Ende jedes Tutorials leicht zu finden sein sollen.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- markdown
- Bereich
- content, documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Ruhig
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 68/100