processing / processing/processing-website

Adding a glossary at the end of tutorials

Open
#682 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
MDX
Stars
90
Forks
122
Avg merge
1h 43m
Merged PRs (30d)
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.

Tutorials referenced:
Color
Objects

Glossary Examples.pdf

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by opening the Color and Objects tutorials linked in the issue and reviewing the attached Glossary Examples PDF alongside their current structure. Add a consistent glossary section with key terms and definitions to the referenced text tutorials, with the terms easy to find at the end of each tutorial.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
content, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.