[Enhancement]: Separate documentation page for latest release and unstable "main" branch. #7989
exousia-doxa
started this conversation in
Feature Requests & Suggestions
Replies: 1 comment 1 reply
-
Great idea. Will have to think about how to implement. At the very least, we can use a working branch and maybe setup a static subdomain for it (quickest hackiest way) |
Beta Was this translation helpful? Give feedback.
1 reply
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
-
State of things
The project documentation currently reflects only the present state of the
main
branch. However, themain
branch is effectively unstable and subject to ongoing development, which makes it difficult for users to rely on this documentation as a reference when they are using the releases provided (v0.7.8
for example).When users install or configure the application from the official Releases, there is no clear indication or separation in the documentation that corresponds to each specific release. This can cause confusion and reduce user confidence, as they might be referring to instructions or features that do not exist or behave differently in the release they are using.
Proposed solution
Maintain a snapshot ("frozen copy") of the documentation for each latest release after it is published. This snapshot would be static and reflect precisely the state of that release, ensuring users can consult documentation that matches the release version installed.
Implementing this would significantly improve clarity and usability for end users setting up the software from releases, and reduce confusion caused by frequent changes in the main branch.
Beta Was this translation helpful? Give feedback.
All reactions