From a5a27f69af682f07c82b283292ec99562407ca7e Mon Sep 17 00:00:00 2001 From: Travis Ralston Date: Tue, 9 Nov 2021 06:40:29 -0700 Subject: [PATCH] Hide room version fragments from table of contents (#3479) The entries were text-less and not really helping anyone. They are included as pages because we need them for templating, but we don't need people to be able to land on them directly. --- content/rooms/fragments/v1-auth-rules.md | 4 ++++ content/rooms/fragments/v1-canonical-json.md | 4 ++++ content/rooms/fragments/v1-redactions.md | 4 ++++ content/rooms/fragments/v2-state-res.md | 4 ++++ content/rooms/fragments/v3-auth-rules.md | 3 +-- content/rooms/fragments/v3-handling-redactions.md | 3 +-- content/rooms/fragments/v4-event-explainer.md | 4 ++++ content/rooms/fragments/v5-signing-requirements.md | 4 ++++ content/rooms/fragments/v6-canonical-json.md | 4 ++++ content/rooms/fragments/v6-redactions.md | 4 ++++ 10 files changed, 34 insertions(+), 4 deletions(-) diff --git a/content/rooms/fragments/v1-auth-rules.md b/content/rooms/fragments/v1-auth-rules.md index 4c611093..d7c4dace 100644 --- a/content/rooms/fragments/v1-auth-rules.md +++ b/content/rooms/fragments/v1-auth-rules.md @@ -1,3 +1,7 @@ +--- +toc_hide: true +--- + The types of state events that affect authorization are: - `m.room.create` diff --git a/content/rooms/fragments/v1-canonical-json.md b/content/rooms/fragments/v1-canonical-json.md index cdff4a5c..480229e9 100644 --- a/content/rooms/fragments/v1-canonical-json.md +++ b/content/rooms/fragments/v1-canonical-json.md @@ -1,3 +1,7 @@ +--- +toc_hide: true +--- + Servers MUST NOT strictly enforce the JSON format specified in the [appendices](/appendices#canonical-json) for the reasons described there. diff --git a/content/rooms/fragments/v1-redactions.md b/content/rooms/fragments/v1-redactions.md index 16bda11d..f876f654 100644 --- a/content/rooms/fragments/v1-redactions.md +++ b/content/rooms/fragments/v1-redactions.md @@ -1,3 +1,7 @@ +--- +toc_hide: true +--- + Upon receipt of a redaction event, the server must strip off any keys not in the following list: diff --git a/content/rooms/fragments/v2-state-res.md b/content/rooms/fragments/v2-state-res.md index 943ef131..508f9c1a 100644 --- a/content/rooms/fragments/v2-state-res.md +++ b/content/rooms/fragments/v2-state-res.md @@ -1,3 +1,7 @@ +--- +toc_hide: true +--- + The room state *S*′(*E*) after an event *E* is defined in terms of the room state *S*(*E*) before *E*, and depends on whether *E* is a state event or a message event: diff --git a/content/rooms/fragments/v3-auth-rules.md b/content/rooms/fragments/v3-auth-rules.md index 93195af3..1a6ae490 100644 --- a/content/rooms/fragments/v3-auth-rules.md +++ b/content/rooms/fragments/v3-auth-rules.md @@ -1,6 +1,5 @@ --- -# unused frontmatter - just fixing a hugo issue where it doesn't parse -# shortcodes at the start of a file. +toc_hide: true --- {{% added-in this=true %}} In room versions 1 and 2, events need a diff --git a/content/rooms/fragments/v3-handling-redactions.md b/content/rooms/fragments/v3-handling-redactions.md index 60fac3e4..45ef39bf 100644 --- a/content/rooms/fragments/v3-handling-redactions.md +++ b/content/rooms/fragments/v3-handling-redactions.md @@ -1,6 +1,5 @@ --- -# unused frontmatter - just fixing a hugo issue where it doesn't parse -# shortcodes at the start of a file. +toc_hide: true --- {{% added-in this=true %}} In room versions 1 and 2, redactions were diff --git a/content/rooms/fragments/v4-event-explainer.md b/content/rooms/fragments/v4-event-explainer.md index 43a45f04..37a37644 100644 --- a/content/rooms/fragments/v4-event-explainer.md +++ b/content/rooms/fragments/v4-event-explainer.md @@ -1,3 +1,7 @@ +--- +toc_hide: true +--- + The event ID is the [reference hash](/server-server-api#calculating-the-reference-hash-for-an-event) of the event encoded using a variation of [Unpadded diff --git a/content/rooms/fragments/v5-signing-requirements.md b/content/rooms/fragments/v5-signing-requirements.md index b1a10e2c..3e8cc20e 100644 --- a/content/rooms/fragments/v5-signing-requirements.md +++ b/content/rooms/fragments/v5-signing-requirements.md @@ -1,3 +1,7 @@ +--- +toc_hide: true +--- + When validating event signatures, servers MUST enforce the `valid_until_ts` property from a key request is at least as large as the `origin_server_ts` for the event being validated. Servers missing a copy diff --git a/content/rooms/fragments/v6-canonical-json.md b/content/rooms/fragments/v6-canonical-json.md index 5f008bd1..6ece1ed8 100644 --- a/content/rooms/fragments/v6-canonical-json.md +++ b/content/rooms/fragments/v6-canonical-json.md @@ -1,3 +1,7 @@ +--- +toc_hide: true +--- + Servers MUST strictly enforce the JSON format specified in the [appendices](/appendices#canonical-json). This translates to a 400 `M_BAD_JSON` error on most endpoints, or discarding of events over diff --git a/content/rooms/fragments/v6-redactions.md b/content/rooms/fragments/v6-redactions.md index 8343afd2..39ee61b8 100644 --- a/content/rooms/fragments/v6-redactions.md +++ b/content/rooms/fragments/v6-redactions.md @@ -1,3 +1,7 @@ +--- +toc_hide: true +--- + Upon receipt of a redaction event, the server must strip off any keys not in the following list: