reactjs / reactjs/react.dev

Why arent old versions of the documentation visible with a subdomain?

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

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

Ngôn ngữ chính
JavaScript
Star
11.8k
Fork
7.9k
Merge trung bình
1 ngày 11 giờ
Pull request đã merge (30 ngày)
11

Mô tả

React maintainers could simply generate the old HTML and cut subdomains of how the site used to look on older versions with older examples and api specifications.

Then link and archive them on the current site where it brings people into the subdomain to view all the documentation.

You could throw a warning on each HTML document that says you are looking at old documentation and it brings you to the main website.

MUI does this just fine for old versions:

https://v0.mui.com/#/

https://mui.com/versions/

Why have the react maintainers gotten away from it for so long? You guys dont even have branches and tags of what the documentation looked like at the time of a particular relase, so I guess people have to go back in main history (find the date or commit title on the release they are looking for) and run yarn dev on this repo to see how the site looked back then? Is that the approach?

Minimally even if you do not implement subdomains on the primary domain, we should go through and create tags against the date which each release was done and people can easily check out the tag revision and run the site locally if it is not in the best interest of the react community to do the subdomain approach.

As a hack then if we do not implement subdomain documentation, you could say on the main site "Looking for older documentation? git checkout a tag and run the site locally" as a hack/workaround.

But with this being such a huge library I would have thought this would be like MUI's documentation.

Maybe I am missing something here and am completely out of line.

Let me know! Thanks for all the hard work regardless. React has changed my front-end life 8 years ago when I started using it. My have times changed since createClass() LOL.

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.

Hướng nghiên cứu

Xem lại lịch sử phát hành của repository react.dev và workflow yarn dev hiện có để hiểu cách xác định và xem tài liệu cũ. So sánh các phương án subdomain, release-tag và local-checkout được đề xuất, sau đó xác định một cách duy nhất được hỗ trợ để người dùng truy cập tài liệu theo phiên bản, cùng với một cảnh báo hoặc liên kết rõ ràng quay lại trang web hiện tại.

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

Đánh giá

Công nghệ
javascript, react
Lĩnh vực
documentation
Loại issue
Tính năng
Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Cần làm rõ
Mức phù hợp với người mới
25/100

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.