reactjs / reactjs/react.dev

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

オープン
#4,923 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

主要言語
JavaScript
スター
11.8k
フォーク
7.9k
平均マージ
1日 11時間
マージ済み PR(30日)
11

説明

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.

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

react.dev リポジトリのリリース履歴と既存の yarn dev ワークフローを調査し、古いドキュメントを特定して閲覧する方法を把握します。提案されているサブドメイン、リリースタグ、ローカルチェックアウトのアプローチを比較し、ユーザーがバージョン付きドキュメントにアクセスするための、サポート対象となる単一の方法と、現在のサイトへ戻る明確な警告またはリンクを定義します。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
javascript, react
領域
documentation
issue の種類
機能追加
難易度
5/5
見積もり時間
1週間以上
活発さ
停滞
明瞭さ
説明が足りない
初心者へのやさしさ
25/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。