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

Aperta
#7,280 0 commenti 4 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
48/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
javascript, react
Ambito
documentation

Direzione di ricerca

Non è indicato alcun file o test. Inizia individuando il punto di ingresso per il rendering della pagina della documentazione e il modo in cui ogni pagina viene associata al relativo file Markdown su GitHub; quindi verifica il pulsante in fondo alla pagina, il branch corretto e l’URL della modalità di modifica, la coerenza dello stile e i link per pagine rappresentative.

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

Descrizione

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.

Lingua principale
JavaScript
Stelle
11.8k
Fork
7.9k
Merge medio
1g 11h
PR unite (30g)
11

Guida per i contributori

Apri la guida per i contributori

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.

Altre issue di reactjs/react.dev

Tutte le issue di reactjs/react.dev

Issue simili

Altre issue su JavaScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.