Hacktoberfest 2026: as issues que os mantenedores marcaram para outubro, abertas e boas para iniciantes. Ver issues do Hacktoberfest

Adding a glossary at the end of tutorials

Aberta
  • Algo errado?
#682 2 comentários 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 1 dia

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
3/5
Tempo estimado
1-2 dias
Facilidade para iniciantes
68/100
Tipo de issue
Documentação
Clareza
Razoavelmente clara
Status de atividade
Pouca atividade
Stack de tecnologia
markdown
Domínio
content, documentation

Direção de pesquisa

Comece abrindo os tutoriais Color e Objects vinculados na issue e revisando o PDF Glossary Examples anexado junto com a estrutura atual deles. Adicione uma seção de glossário consistente, com termos-chave e definições, aos tutoriais de texto referenciados, deixando os termos fáceis de encontrar no final de cada tutorial.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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

Linguagem predominante
MDX
Estrelas
91
Forks
121
Merge médio
1h 20min
PRs com merge (30d)
4

Preparar o ambiente

Este projeto não oferece contêiner de desenvolvimento, Dockerfile nem guia de contribuição, então a configuração fica por sua conta: comece pelo README e veja nosso guia da primeira contribuição para os passos gerais.

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de processing/processing-website

Todas as issues de processing/processing-website

Issues semelhantes

Mais issues de Content

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.