-
Notifications
You must be signed in to change notification settings - Fork 139
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
Implemeent versioning for the documentation #7
Comments
The documentation directly available at |
Completely agree with the select widget for changing doc versions and that the default docs should represent the latest stable version. As a first step we should at least have some kind of indication for the version (before we add multiple versions). |
The Jest docs could serve as example: https://github.com/facebook/jest/tree/master/website/versioned_docs |
Introducing doc versioning will require refactoring. I think this only makes sense if Decap CMS plans to move to a more breaking changes style major releases. When upgrading sites from Maybe others experienced breaking changes? @martinjagodic can you comment on the future release style plans? Otherwise I vote to not implement such a style docs. |
I think this is a good idea long-term, but it's not a priority right now. Some breaking changes will occur with the next major version which will include the UX redesign. Let's keep this open for that phase. |
To avoid confusion, we should have some indication in the documentation Website to which version they are relating to (e.g. current documentation site is relevant for the latest beta version).
The text was updated successfully, but these errors were encountered: