processing / processing/processing-website

Core reference and Libraries reference entries share the same template

Ouverte
#396 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Langage dominant
MDX
Étoiles
90
Forks
122
Merge moyen
1 h 43 min
PR mergées (30 j)
3

Description

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.

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par examiner le template partagé des pages de référence et le point d’entrée java-generate mentionné dans l’issue, puis suivez la manière dont les classes Java sont reconstruites. Le travail est terminé lorsque les pages Library sélectionnent Libraries dans la navigation de gauche, prennent en charge les messages Javadoc personnalisés et que les pages Video et Sound gèrent leurs liens Javadoc ou leurs Javadocs générés comme prévu.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
java
Domaine
documentation
Type d'issue
Fonctionnalité
Difficulté
4/5
Temps estimé
3-5 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
42/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.