processing / processing/processing-website
Adding a glossary at the end of tutorials
Personne n'a encore pris cette issue.
- Langage dominant
- MDX
- Étoiles
- 90
- Forks
- 122
- Merge moyen
- 1 h 43 min
- PR mergées (30 j)
- 3
Description
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.
Guide de contribution
Aucun guide de contribution indexé pour ce dépôt
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par ouvrir les tutoriels Color et Objects liés dans l’issue et par examiner le PDF Glossary Examples joint ainsi que leur structure actuelle. Ajoutez une section de glossaire cohérente, avec les termes clés et leurs définitions, aux tutoriels textuels concernés, en veillant à ce que les termes soient faciles à trouver à la fin de chaque tutoriel.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- markdown
- Domaine
- content, documentation
- Type d'issue
- Documentation
- Difficulté
- 3/5
- Temps estimé
- 1-2 jours
- Activité
- Calme
- Clarté
- Plutôt claire
- Accessibilité débutants
- 68/100