processing / processing/processing-website

Core reference and Libraries reference entries share the same template

Offen
#396 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
MDX
Sterne
90
Forks
122
Ø Merge
1 Std. 43 Min.
Gemergte PRs (30 T.)
3

Beschreibung

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.

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne damit, das gemeinsame Template für Referenzseiten und den im Issue genannten Einstiegspunkt java-generate zu untersuchen, und verfolge dann, wie die Java-Klassen neu erstellt werden. Als erledigt gilt die Aufgabe, wenn Library-Seiten im linken Navigationsbereich Libraries auswählen, benutzerdefinierte Javadoc-Nachrichten unterstützen und die Seiten Video und Sound ihre Javadoc-Links oder generierten Javadocs wie vorgesehen verarbeiten.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
java
Bereich
documentation
Issue-Typ
Feature
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
42/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.