[Suggestion]: Add "Edit this page" button to the bottom of each documentation page
まだ誰も着手していません。
- 主要言語
- JavaScript
- スター
- 11.8k
- フォーク
- 7.9k
- 平均マージ
- 1日 11時間
- マージ済み PR(30日)
- 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:
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.
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
ファイルもテストも指定されていません。まず、ドキュメントページをレンダリングするエントリポイントと、各ページが GitHub 上のどの Markdown ファイルに対応するかを特定します。次に、ページ下部のボタン、正しいブランチと編集モードの URL、一貫したスタイル、および代表的なページのリンクを確認します。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- javascript, react
- 領域
- documentation
- issue の種類
- 機能追加
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 48/100