reactjs / reactjs/react.dev

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

Ouverte
#4,923 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Langage dominant
JavaScript
Étoiles
11.8k
Forks
7.9k
Merge moyen
1 j 11 h
PR mergées (30 j)
11

Description

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.

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Examinez l’historique des versions du dépôt react.dev et le workflow yarn dev existant afin de comprendre comment identifier et consulter l’ancienne documentation. Comparez les approches proposées du sous-domaine, du tag de release et du checkout local, puis définissez une seule méthode prise en charge permettant aux utilisateurs d’accéder à la documentation versionnée, ainsi qu’un avertissement ou un lien clair renvoyant vers le site actuel.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
javascript, react
Domaine
documentation
Type d'issue
Fonctionnalité
Difficulté
5/5
Temps estimé
Plus d'une semaine
Activité
À l'abandon
Clarté
À clarifier
Accessibilité débutants
25/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.