[Suggestion]: Add "Edit this page" button to the bottom of each documentation page

Ouverte
#7,280 0 commentaires 4 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
3/5
Temps estimé
1-2 jours
Accessibilité débutants
48/100
Type d'issue
Fonctionnalité
Clarté
Plutôt claire
Activité
À l'abandon
Stack technique
javascript, react
Domaine
documentation

Piste de recherche

Aucun fichier ni test n’est indiqué. Commencez par localiser le point d’entrée du rendu des pages de documentation et la manière dont chaque page correspond à son fichier Markdown sur GitHub ; vérifiez ensuite le bouton en bas de page, la branche correcte et l’URL du mode d’édition, la cohérence du style ainsi que les liens de pages représentatives.

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

Description

type: documentation
Summary

Implement an "Edit this page" button at the bottom of each documentation page, linking directly to the corresponding Markdown file on GitHub, allowing users to easily suggest improvements and corrections.

Example in Docusaurus:

image

Page

No response

Details

To encourage community contributions and streamline the process of updating documentation, it would be helpful to add an "Edit this page" button at the bottom of each documentation page. This button should link directly to the corresponding Markdown file in the GitHub repository, making it simple for users to suggest edits or fix errors.

Acceptance Criteria:

  • Add an "Edit this page" button to the bottom of each documentation page.
  • Ensure that the button links directly to the Markdown file in the GitHub repository.
  • The link should open in edit mode if possible, so users can quickly make changes and propose pull requests.
  • The button should be styled consistently with the rest of the documentation site and be easy to find.

Additional Notes:
Please ensure that links point to the correct branch (e.g., main or docs) in the repository so users are editing the most up-to-date version of the file.

Langage dominant
JavaScript
Étoiles
11.8k
Forks
7.9k
Merge moyen
16 h 6 min
PR mergées (30 j)
7

Guide de contribution

Ouvrir le guide de contribution

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.

Autres issues de reactjs/react.dev

Toutes les issues de reactjs/react.dev

Issues similaires

Plus d'issues JavaScript

Recevez les nouvelles issues par e-mail

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