-
Notifications
You must be signed in to change notification settings - Fork 1.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Feature: Plan for versioned documentation #6144
Comments
Current consensus is that we should have two doc sites, we didn't go into detail about using Logistically the following things should happen:
|
Now that #6204 is released, we have the necessary build infrastructure to manage multiple documentation websites, but any further progress on that is blocked on other people with elevated privileges doing things:
Based on whatever course of action happens for 2 & 3, we can easily add the appropriate identifying information to the website (basically just making it clear what version you're looking at, maybe by putting the version number in the header like react.dev, possibly some other sort of warning if it's tracking main or nightly) |
Currently, all documentation is generated whenever main is deployed. This can be confusing for users when there are new APIs or deprecations such that the documentation does not match the behavior or features of the latest released version.
A short-term plan might be to simply mark the documentation website (and playground) with some information that lets users know that the documentation reflects main and may not be available in a released version. Docusaurus does this with a note:
Longer term, whenever the API is considered stable, it would make sense to have multiple doc website available (e.g. 19.react.dev, 18.react.dev) or to use docusaurus versioning. Some possibilities for interim middle-ground solutions:
The text was updated successfully, but these errors were encountered: