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

Aberta
#7,280 0 comentários 4 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
3/5
Tempo estimado
1-2 dias
Facilidade para iniciantes
48/100
Tipo de issue
Funcionalidade
Clareza
Razoavelmente clara
Status de atividade
Estagnada
Stack de tecnologia
javascript, react
Domínio
documentation

Direção de pesquisa

Nenhum arquivo ou teste é nomeado. Comece localizando o ponto de entrada da renderização da página de documentação e como cada página corresponde ao seu arquivo Markdown no GitHub; em seguida, verifique o botão na parte inferior da página, a branch correta e a URL do modo de edição, a consistência do estilo e os links de páginas representativas.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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.

Linguagem predominante
JavaScript
Estrelas
11.8k
Forks
7.9k
Merge médio
16h 6min
PRs com merge (30d)
7

Guia de contribuição

Abrir o guia de contribuição

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de reactjs/react.dev

Todas as issues de reactjs/react.dev

Issues semelhantes

Mais issues de JavaScript

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.