Update documentation style & fix room version heading order (#3683)

* Update documentation style & fix room version heading order

Also add a missing signing key section to v6.

This additionally contains various edits to the fragments to have them make a little bit more sense in context.

Finally, this updates various aspects of the documentation style which haven't previously been considered - they're added here considering we're in the area.

* changelog

* enhanced changelogs

* Minor wording adjustments

* Apply suggestions from code review

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>
This commit is contained in:
Travis Ralston 2022-01-31 15:18:58 -07:00 committed by GitHub
parent 990dfec94b
commit d4c74d37a9
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
14 changed files with 168 additions and 81 deletions

View file

@ -188,9 +188,13 @@ Some consequences of these rules:
The following sections have not been modified since v6, but are included for
completeness.
### State resolution
### Redactions
{{% rver-fragment name="v2-state-res" %}}
{{% rver-fragment name="v6-redactions" %}}
### Handling redactions
{{% rver-fragment name="v3-handling-redactions" %}}
### Event IDs
@ -200,9 +204,9 @@ completeness.
{{% rver-fragment name="v4-event-format" %}}
### Handling redactions
### State resolution
{{% rver-fragment name="v3-handling-redactions" %}}
{{% rver-fragment name="v2-state-res" %}}
### Canonical JSON
@ -211,7 +215,3 @@ completeness.
### Signing key validity period
{{% rver-fragment name="v5-signing-requirements" %}}
### Redactions
{{% rver-fragment name="v6-redactions" %}}