reactjs / reactjs/react.dev

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

未關閉
#7,280 0 則留言 4 個 reaction 已指派 0 人 在 GitHub 檢視

還沒有人認領這個 Issue。

type: documentation
主要語言
JavaScript
星號
11.8k
分支
7.9k
平均合併
1 天 11 小時
30 天內合併 PR
11

描述

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.

貢獻指南

開啟貢獻指南

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

研究方向

未指定檔案或測試。首先定位文件頁面呈現的進入點,以及每個頁面如何對應到 GitHub 上的 Markdown 檔案;接著驗證頁面底部按鈕、正確的分支和編輯模式 URL、一致的樣式,以及具代表性頁面的連結。

由索引模型根據 Issue 內容生成。

評估

技術堆疊
javascript, react
領域
documentation
Issue 類型
功能
難度
3/5
預估耗時
1-2 天
活躍度
停滯
描述清晰度
基本清楚
新手友好度
48/100

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。