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

Đang mở
#7,280 0 bình luận 4 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
48/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
javascript, react
Lĩnh vực
documentation

Hướng nghiên cứu

Không có tệp hoặc bài kiểm thử nào được nêu tên. Trước tiên, hãy xác định điểm vào để kết xuất trang tài liệu và cách mỗi trang ánh xạ tới tệp Markdown tương ứng trên GitHub; sau đó xác minh nút ở cuối trang, branch chính xác và URL của chế độ chỉnh sửa, kiểu dáng nhất quán và các liên kết của những trang đại diện.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.

Ngôn ngữ chính
JavaScript
Star
11.8k
Fork
7.9k
Merge trung bình
16 giờ 6 phút
Pull request đã merge (30 ngày)
7

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của reactjs/react.dev

Tất cả issue của reactjs/react.dev

Issue tương tự

Thêm issue về JavaScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.