processing / processing/processing-website

Core reference and Libraries reference entries share the same template

Aperta
#396 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Lingua principale
MDX
Stelle
90
Fork
122
Merge medio
1h 43m
PR unite (30g)
3

Descrizione

Because there's a single template to build all of the reference pages, the Library reference pages have the wrong left-nav option selected (Reference and not Libraries). Also, they can't have a custom message at the top of the page about the Javadoc. I think this requires digging into java-generate and rebuilding the Java classes.

In addition, the non-core Libraries from the Processing Foundation (Video and Sound) can't have a separate header message. They link to the Libraries Javadoc, but the code isn't there. Thinking about this more, we could probably build those Javadocs and add them while the rest are built.

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia esaminando il template condiviso delle pagine di riferimento e l’entry point java-generate menzionato nell’issue, quindi traccia il modo in cui vengono ricreate le classi Java. Il lavoro è completato quando le pagine Library selezionano Libraries nella navigazione a sinistra, supportano messaggi Javadoc personalizzati e le pagine Video e Sound gestiscono i propri link Javadoc o i Javadocs generati come previsto.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
java
Ambito
documentation
Tipo di issue
Funzionalità
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
42/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.