Open erezrokah opened 4 years ago
(e.g. current documentation site is relevant for the latest beta version).
The documentation directly available at netlifycms.org
should be for the most current stable release.
A select (widget) could control which specific doc version to display but the default should be the stable version.
(e.g. current documentation site is relevant for the latest beta version).
The documentation directly available at
netlifycms.org
should be for the most current stable release. A select (widget) could control which specific doc version to display but the default should be the stable version.
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 v2
to v3
I don't recall any issues.
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).