reactjs / reactjs/react.dev

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

Offen
#4,923 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
JavaScript
Sterne
11.8k
Forks
7.9k
Ø Merge
1 T. 11 Std.
Gemergte PRs (30 T.)
11

Beschreibung

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.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Überprüfe die Release-Historie des react.dev-Repositorys und den bestehenden yarn dev-Workflow, um zu verstehen, wie ältere Dokumentation identifiziert und angezeigt werden kann. Vergleiche die vorgeschlagenen Subdomain-, Release-Tag- und Local-Checkout-Ansätze und definiere anschließend eine einzige unterstützte Möglichkeit für den Zugriff auf versionierte Dokumentation sowie eine klare Warnung oder einen Link zurück zur aktuellen Website.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
javascript, react
Bereich
documentation
Issue-Typ
Feature
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.