reactjs / reactjs/react.dev

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

Aperta
#4,923 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Lingua principale
JavaScript
Stelle
11.8k
Fork
7.9k
Merge medio
1g 11h
PR unite (30g)
11

Descrizione

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.

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Esamina la cronologia delle release del repository react.dev e il workflow yarn dev esistente per capire come identificare e consultare la documentazione precedente. Confronta gli approcci proposti del sottodominio, del release tag e del local checkout, quindi definisci un unico modo supportato per consentire agli utenti di accedere alla documentazione versionata e un avviso o un link chiaro che rimandi al sito attuale.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
javascript, react
Ambito
documentation
Tipo di issue
Funzionalità
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.