processing / processing/processing-website

Adding "Go to source" link to reference pages

Ouverte
#704 2 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

Which area of the website does this enhancement relate to?

Reference

Describe the enhancement

Reference pages don't have any reference, connecting them to their source version in this repo. Let's say you want update a reference page, or simply fix a typo: https://processing.org/reference/frameCount.html While the change is only a single letter, because the website has no reference to https://github.com/processing/processing-website/blob/1fce63d07182becca614b95ab76b3b1416424d8d/content/references/translations/en/processing/frameCount.json , one should learn where the content is kept and search for the content in the repo.

Why is this enhancement important?

The lack of direct connection the presentation and source layer for reference docs makes the contribution process harder.

Additional context

No response

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 la page de référence de frameCount et le fichier correspondant content/references/translations/en/processing/frameCount.json. Examinez la manière dont la page de référence est présentée, puis déterminez où doit se trouver un lien vers la source ; le travail est terminé lorsque les pages de référence fournissent un lien direct vers leur contenu source dans ce dépôt.

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

Évaluation

Domaine
documentation
Type d'issue
Fonctionnalité
Difficulté
3/5
Temps estimé
1-2 jours
Activité
Active
Clarté
Plutôt claire
Accessibilité débutants
72/100

Recevez les nouvelles issues par e-mail

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