Hacktoberfest 2026: die Issues, die Maintainer für den Oktober markiert haben – offen und einsteigerfreundlich. Hacktoberfest-Issues durchsuchen

Adding a glossary at the end of tutorials

Offen
  • Stimmt etwas nicht?
#682 2 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Anfängerfreundlichkeit
68/100
Issue-Typ
Dokumentation
Klarheit
Größtenteils klar
Aktivitätsstatus
Ruhig
Tech-Stack
markdown
Bereich
content, documentation

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.

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.

Tutorials referenced:
Color
Objects

Glossary Examples.pdf

Vorherrschende Sprache
MDX
Sterne
90
Forks
122
Ø Merge
1 Std. 20 Min.
Gemergte PRs (30 T.)
4

Entwicklungsumgebung

Die Einrichtungsdateien dieses Projekts haben wir noch nicht geprüft. Beginnen Sie mit der README; die allgemeinen Schritte stehen in unserem Leitfaden für den ersten Beitrag.

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus processing/processing-website

Alle Issues in processing/processing-website

Ähnliche Issues

Weitere Issues zu Content

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.