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

Documentation Revamp / Organisation

Aberta
  • Algo errado?
#1,350 6 comentários 1 reação 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
5/5
Tempo estimado
Mais de uma semana
Facilidade para iniciantes
20/100
Tipo de issue
Refatoração
Clareza
Precisa de esclarecimento
Status de atividade
Estagnada
Stack de tecnologia
java
Domínio
build-system, developer-experience, documentation

Direção de pesquisa

Comece lendo a issue relacionada #1204 e mapeando como processing-website, processing-doclet, processing-examples, processing4 e processing4-javadocs atualmente trocam conteúdo gerado. Revise as etapas existentes de build e release antes de escolher um caminho de migração. Considera-se concluído quando os repositórios não exigirem mais colocação manual no mesmo local nem cópias somente leitura, e as ações documentadas de geração e atualização estiverem automatizadas ou consolidadas.

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

Descrição

documentation

The examples and some of the documentation around Processing are kind of all over the place

The Goal

Have one repo where documentation lives: processing-website

The current issues
Suggested actions
  • Get rid of any instances where the developer has to make sure repositories live next to each other on disk
  • Migrate processing-doclet into the processing-website and make it run on build
    • Research further into migrating / replicating the custom doclet into Gradle and make it run w gradle
  • Delete processing-doclet repo
  • Migrate processing-examples into the processing-website
    • Tested, still need to figure out how to merge the folders whilst keeping history
  • Archive processing-examples
  • Remove all read-only files from processing-website
  • Move the generation of keywords.txt back into the processing4 repo
  • Add an automatic update trigger for processing4-javadoc to the processing4 repo release action (or migrate processing4-javadoc into the processing4 repo)
    • Migrate Javadoc from Ant to Gradle
Related PRs/Issues/Other documentation

#1204

Linguagem predominante
Java
Estrelas
497
Forks
183
Merge médio
4h 39min
PRs com merge (30d)
3

Preparar o ambiente

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/processing4

Todas as issues de processing/processing4

Issues semelhantes

Mais issues de Java

Receba novas issues na sua caixa de entrada

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