Fully specify room versions #3432
Merged
Conversation
This file contains 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
turt2live
added
the
blocked
|
|
richvdh
reviewed
Oct 13, 2021
There was a problem hiding this comment.
I've not done a complete review, but this certainly looks like the right direction imho - thank you very much @turt2live for putting the work in to improve this!
turt2live
removed
the
blocked
turt2live
force-pushed
the
travis/fully-doc-room-versions
branch
from
fe21c16 to
8dbbf94
Compare
|
@richvdh redactions should be differently clear now. The rendered spec is probably better to review than the code side, given all the templating and such. |
richvdh
reviewed
Oct 18, 2021
Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
richvdh
reviewed
Oct 18, 2021
Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Fixes #3153
Builds on top of #3423(merged)Builds on top of #3425(merged)The general approach taken for this is to reuse as much as possible when the text would be duplicated beyond trivial copy/paste. For example, v1's state resolution algorithm is left as-is in
v1.md, but v2's state res algorithm is split out to a "fragment" because more than 2 room versions will be making reference to it.Some things somewhat arbitrarily did (or didn't) get converted into fragments depending on how annoying it was to make it a fragment. An example of this is the auth rule changes in v6 and v7: while a lot of the text could be broken out to fragments, it's actually easier to just copy/paste the whole thing and manually make edits. Other room versions won't be making use of the algorithms as defined, so it's not worth breaking out to a fragment as a whole either. v3's auth rules got carried over up until v5 however, so it got split out.
Additionally, every room version now has an "Unchanged from vPrev" heading so readers can easily see what the whole room version looks like. I've tried to keep the heading order roughly the same between room versions, and deliberately put the client-facing redactions algorithm last so client authors can avoid the server-side stuff as much as possible (didn't even want the possibility for them to scroll down into server stuff and become confused).
This is probably best reviewed from a rendered version of the spec, if you can dig out a link from our CI (sorry).
Preview: https://pr3432--matrix-org-previews.netlify.app