improve versioning docs - #721
Merged
Merged
Conversation
- adds section on versioning when a specific commit needs to be targeted - mention maysync alongside willsync - some cleanup
rkratky
requested changes
Jul 23, 2026
rkratky
left a comment
rkratky
left a comment
Collaborator
There was a problem hiding this comment.
Thank you very much for this overhaul, @grayson-wolf!
I added a few suggestions, some nitpicks, and and some changes to keep things more in line with our attempts at consistency :)
Co-authored-by: Robert Krátký <robert.kratky@canonical.com>
Contributor
Author
|
Thanks for the feedback! I've applied your suggested changes. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
I really don't like the way this page is structured right now (it feels very difficult to digest) and I'd like to do a more thorough rewrite at some point, but for now I've just added some missing details and a flowchart that I think will help a bit.I've done this rewrite, moving the big table of examples to the bottom and leaving more compact simpler examples embedded within the text itself. I also added some more information that wasn't there before.