processing / processing/processing-website
Adding a glossary at the end of tutorials
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- MDX
- Estrellas
- 90
- Forks
- 122
- Merge medio
- 1 h 43 min
- PR fusionados (30 d)
- 3
Descripción
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.
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Comienza abriendo los tutoriales de Color y Objects enlazados en el issue y revisando el PDF adjunto Glossary Examples junto con su estructura actual. Añade una sección de glosario coherente, con términos clave y definiciones, a los tutoriales de texto mencionados, de modo que los términos sean fáciles de encontrar al final de cada tutorial.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- markdown
- Área
- content, documentation
- Tipo de issue
- Documentación
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Estado de actividad
- Tranquilo
- Claridad
- Bastante claro
- Aptitud para principiantes
- 68/100