Provide MD checklists for the changelog (#1937)

* Output changelog checklists Fixes: #1682 Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
2 months ago · 00af39ecca
parent ace2712719
commit 00af39ecca
22 changed files with 219 additions and 151 deletions
--- a/.github/workflows/main.yml
+++ b/.github/workflows/main.yml
@ -177,7 +177,7 @@ jobs:
        uses: actions/upload-artifact@v4
        with:
          name: changelog-artifact
-          path: content/changelog/vUNSTABLE.md
+          path: content/changelog/unstable.md

  build-spec:
    name: "📖 Build the spec"
--- a/changelogs/header.md
+++ b/changelogs/header.md
@ -6,11 +6,10 @@ Variables:
    DATE     = Replaced by the date (eg: April 01, 2021)
 -->

-## VERSION
-
 <table class="release-info">
 <tr><th>Git commit</th><td><a href="https://github.com/matrix-org/matrix-spec/tree/VERSION">https://github.com/matrix-org/matrix-spec/tree/VERSION</a></td>
 <tr><th>Release date</th><td>DATE</td>
+<tr><th>Checklist</th><td><a href="/changelog/VERSION/checklist.md">checklist.md</a></td>
 </table>

 <!-- Intentionally blank line to ensure headers work in the concatenated changelog -->
--- a/changelogs/internal/newsfragments/1937.clarification
+++ b/changelogs/internal/newsfragments/1937.clarification
@ -0,0 +1 @@
+Provide markdown checklists for changelogs under `/changelog/$VERSION/checklist.md`.
--- a/changelogs/template.md.jinja
+++ b/changelogs/template.md.jinja
@ -1,7 +1,7 @@
 {% for section_name, section in sections.items() %}
 {% if section_name %}

-### {{section_name}}
+## {{section_name}}
 {% endif %}

 {% if section %}
--- a/config.toml
+++ b/config.toml
@ -138,3 +138,11 @@ sidebar_menu_compact = true
  [[module.imports]]
    path = "github.com/matrix-org/docsy"
    disable = false
+
+# custom output formats
+
+[outputFormats]
+  [outputFormats.Checklist]
+    mediaType = "text/markdown"
+    isPlainText = true
+    baseName = "checklist"
--- a/content/changelog/_index.md
+++ b/content/changelog/_index.md
@ -0,0 +1,7 @@
+---
+title: Changelog
+type: docs
+weight: 1000
+---
+
+{{% changelog/changelogs %}}
--- a/content/changelog/historical.md
+++ b/content/changelog/historical.md
@ -1,18 +1,15 @@
 ---
-title: Changelog
+title: Historical versions
 type: docs
-weight: 1000
+outputs:
+  - html
 ---

-{{% changelog/changelog-description %}}
+Before version 1.1, versioning was applied at the level of individual API specifications.
+This section includes links to these versions of the APIs.

-{{% changelog/changelogs %}}
+## Client-Server API

-<h2 id="historical-versions" class="no-numbers">Historical versions</h2>
-
-Before version 1.1, versioning was applied at the level of individual API specifications. This section includes links to these versions of the APIs.
-
-* **Client-Server API**
  -   [r0.6.1](https://matrix.org/docs/spec/client_server/r0.6.1.html)
  -   [r0.6.0](https://matrix.org/docs/spec/client_server/r0.6.0.html)
  -   [r0.5.0](https://matrix.org/docs/spec/client_server/r0.5.0.html)
@ -26,22 +23,26 @@ Before version 1.1, versioning was applied at the level of individual API specif
      The last draft before the spec was formally released in version
      r0.0.0.

-* **Server-Server API**
+## Server-Server API
+
  -   [r0.1.4](https://matrix.org/docs/spec/server_server/r0.1.4.html)
  -   [r0.1.3](https://matrix.org/docs/spec/server_server/r0.1.3.html)
  -   [r0.1.2](https://matrix.org/docs/spec/server_server/r0.1.2.html)
  -   [r0.1.1](https://matrix.org/docs/spec/server_server/r0.1.1.html)
  -   [r0.1.0](https://matrix.org/docs/spec/server_server/r0.1.0.html)

-* **Application Service API**
+## Application Service API
+
  -   [r0.1.1](https://matrix.org/docs/spec/application_service/r0.1.1.html)
  -   [r0.1.0](https://matrix.org/docs/spec/application_service/r0.1.0.html)

-* **Identity Service API**
+## Identity Service API
+
  -   [r0.3.0](https://matrix.org/docs/spec/identity_service/r0.3.0.html)
  -   [r0.2.1](https://matrix.org/docs/spec/identity_service/r0.2.1.html)
  -   [r0.2.0](https://matrix.org/docs/spec/identity_service/r0.2.0.html)
  -   [r0.1.0](https://matrix.org/docs/spec/identity_service/r0.1.0.html)

-* **Push Gateway API**
+## Push Gateway API
+
  -   [r0.1.0](https://matrix.org/docs/spec/push_gateway/r0.1.0.html)
--- a/content/changelog/v1.1.md
+++ b/content/changelog/v1.1.md
@ -1,4 +1,10 @@
 ---
+title: v1.1 Changelog
+linkTitle: v1.1
+type: docs
+outputs:
+  - html
+  - checklist
 date: 2021-11-09T00:00:00+0000
 ---
 <!--
@ -9,15 +15,14 @@ Variables:
    November 09, 2021     = Replaced by the date (eg: April 01, 2021)
 -->

-## v1.1
-
 <table class="release-info">
 <tr><th>Git commit</th><td><a href="https://github.com/matrix-org/matrix-doc/tree/v1.1">https://github.com/matrix-org/matrix-doc/tree/v1.1</a></td>
 <tr><th>Release date</th><td>November 09, 2021</td>
+<tr><th>Checklist</th><td><a href="/changelog/v1.1/checklist.md">checklist.md</a></td>
 </table>

 <!-- Intentionally blank line to ensure headers work in the concatenated changelog -->
-### Client-Server API
+## Client-Server API


 <strong>Breaking Changes</strong>
@ -110,7 +115,7 @@ Variables:
 - Fix documentation errors around `threepid_creds`. ([#3471](https://github.com/matrix-org/matrix-doc/issues/3471))


-### Server-Server API
+## Server-Server API


 <strong>New Endpoints</strong>
@ -136,7 +141,7 @@ Variables:
 - Tweak the example PDU diagram to better demonstrate situations with multiple `prev_events`. ([#3340](https://github.com/matrix-org/matrix-doc/issues/3340))


-### Application Service API
+## Application Service API


 <strong>Spec Clarifications</strong>
@ -145,7 +150,7 @@ Variables:
 - Fix various typos throughout the specification. ([#2888](https://github.com/matrix-org/matrix-doc/issues/2888))


-### Identity Service API
+## Identity Service API


 <strong>New Endpoints</strong>
@ -168,7 +173,7 @@ Variables:
 - Describe how [MSC2844](https://github.com/matrix-org/matrix-doc/pull/2844) affects the `/versions` endpoint. ([#3459](https://github.com/matrix-org/matrix-doc/issues/3459))


-### Push Gateway API
+## Push Gateway API


 <strong>Spec Clarifications</strong>
--- a/content/changelog/v1.10.md
+++ b/content/changelog/v1.10.md
@ -1,4 +1,10 @@
 ---
+title: v1.10 Changelog
+linkTitle: v1.10
+type: docs
+outputs:
+  - html
+  - checklist
 date: 2024-03-22T09:59:45-06:00
 ---
 <!--
@ -9,16 +15,15 @@ Variables:
    March 22, 2024     = Replaced by the date (eg: April 01, 2021)
 -->

-## v1.10
-
 <table class="release-info">
 <tr><th>Git commit</th><td><a href="https://github.com/matrix-org/matrix-spec/tree/v1.10">https://github.com/matrix-org/matrix-spec/tree/v1.10</a></td>
 <tr><th>Release date</th><td>March 22, 2024</td>
+<tr><th>Checklist</th><td><a href="/changelog/v1.10/checklist.md">checklist.md</a></td>
 </table>

 <!-- Intentionally blank line to ensure headers work in the concatenated changelog -->

-### Client-Server API
+## Client-Server API

 **Backwards Compatible Changes**

@ -50,7 +55,7 @@ Variables:
 - Clarify that the `m.push_rules` account data type cannot be set using the `/account_data` API, as per [MSC4010](https://github.com/matrix-org/matrix-spec-proposals/pull/4010). ([#1763](https://github.com/matrix-org/matrix-spec/issues/1763))


-### Server-Server API
+## Server-Server API

 **Spec Clarifications**

@ -59,36 +64,36 @@ Variables:
 - Clarify that the `children_state`, `room_type` and `allowed_room_ids` properties in the items of the `children` array of the response of the `GET /hierarchy` endpoint are not required. ([#1741](https://github.com/matrix-org/matrix-spec/issues/1741))


-### Application Service API
+## Application Service API

 **Spec Clarifications**

 - Clarify that the `/login` and `/register` endpoints should fail when using the `m.login.application_service` login type without a valid `as_token`. ([#1744](https://github.com/matrix-org/matrix-spec/issues/1744))


-### Identity Service API
+## Identity Service API

 No significant changes.


-### Push Gateway API
+## Push Gateway API

 No significant changes.


-### Room Versions
+## Room Versions

 **Spec Clarifications**

 - For room versions 7 through 11: Clarify that `invite->knock` is not a legal transition. ([#1717](https://github.com/matrix-org/matrix-spec/issues/1717))


-### Appendices
+## Appendices

 No significant changes.


-### Internal Changes/Tooling
+## Internal Changes/Tooling

 **Spec Clarifications**

--- a/content/changelog/v1.11.md
+++ b/content/changelog/v1.11.md
@ -1,4 +1,10 @@
 ---
+title: v1.11 Changelog
+linkTitle: v1.11
+type: docs
+outputs:
+  - html
+  - checklist
 date: 2024-06-20T10:20:43-06:00
 ---
 <!--
@ -9,16 +15,15 @@ Variables:
    June 20, 2024     = Replaced by the date (eg: April 01, 2021)
 -->

-## v1.11
-
 <table class="release-info">
 <tr><th>Git commit</th><td><a href="https://github.com/matrix-org/matrix-spec/tree/v1.11">https://github.com/matrix-org/matrix-spec/tree/v1.11</a></td>
 <tr><th>Release date</th><td>June 20, 2024</td>
+<tr><th>Checklist</th><td><a href="/changelog/v1.11/checklist.md">checklist.md</a></td>
 </table>

 <!-- Intentionally blank line to ensure headers work in the concatenated changelog -->

-### Client-Server API
+## Client-Server API

 **Deprecations**

@ -63,7 +68,7 @@ Variables:
 - Clarify that `/media/v3/upload/{serverName}/{mediaId}` requires authentication. ([#1872](https://github.com/matrix-org/matrix-spec/issues/1872))


-### Server-Server API
+## Server-Server API

 **Deprecations**

@ -87,26 +92,26 @@ Variables:
 - Fix various typos throughout the specification. ([#1877](https://github.com/matrix-org/matrix-spec/issues/1877))


-### Application Service API
+## Application Service API

 **Spec Clarifications**

 - Clarify that appservices should be notified of events relating to the `sender_localpart` user. ([#1810](https://github.com/matrix-org/matrix-spec/issues/1810))


-### Identity Service API
+## Identity Service API

 **Deprecations**

 - Authentication using a query string is now deprecated, as per [MSC4126](https://github.com/matrix-org/matrix-spec-proposals/issues/4126). The `Authorization` header should be used instead. ([#1808](https://github.com/matrix-org/matrix-spec/issues/1808))


-### Push Gateway API
+## Push Gateway API

 No significant changes.


-### Room Versions
+## Room Versions

 **Spec Clarifications**

@ -116,7 +121,7 @@ No significant changes.
 - Generate the Table of Contents with Hugo rather than JavaScript. ([#1884](https://github.com/matrix-org/matrix-spec/issues/1884))


-### Appendices
+## Appendices

 **Deprecations**

@ -129,7 +134,7 @@ No significant changes.
 - Move size limits for user, room and event IDs into the appendix and clarify that the length is to be measured in bytes. ([#1850](https://github.com/matrix-org/matrix-spec/issues/1850))


-### Internal Changes/Tooling
+## Internal Changes/Tooling

 **Spec Clarifications**

--- a/content/changelog/v1.2.md
+++ b/content/changelog/v1.2.md
@ -1,4 +1,10 @@
 ---
+title: v1.2 Changelog
+linkTitle: v1.2
+type: docs
+outputs:
+  - html
+  - checklist
 date: 2022-02-02T00:00:00+0000
 ---
 <!--
@ -9,15 +15,14 @@ Variables:
    February 02, 2022     = Replaced by the date (eg: April 01, 2021)
 -->

-## v1.2
-
 <table class="release-info">
 <tr><th>Git commit</th><td><a href="https://github.com/matrix-org/matrix-doc/tree/v1.2">https://github.com/matrix-org/matrix-doc/tree/v1.2</a></td>
 <tr><th>Release date</th><td>February 02, 2022</td>
+<tr><th>Checklist</th><td><a href="/changelog/v1.2/checklist.md">checklist.md</a></td>
 </table>

 <!-- Intentionally blank line to ensure headers work in the concatenated changelog -->
-### Client-Server API
+## Client-Server API


 <strong>Breaking Changes</strong>
@ -65,7 +70,7 @@ Variables:
 - Fix the rendering of the responses for various API endpoints. ([#3674](https://github.com/matrix-org/matrix-doc/issues/3674))


-### Server-Server API
+## Server-Server API


 <strong>New Endpoints</strong>
@ -88,7 +93,7 @@ Variables:
 - Fix the rendering of the responses for various API endpoints. ([#3674](https://github.com/matrix-org/matrix-doc/issues/3674))


-### Application Service API
+## Application Service API


 <strong>Spec Clarifications</strong>
@ -99,7 +104,7 @@ Variables:
 - Correct the documentation for the response value for `GET /_matrix/app/v1/thirdparty/protocol/{protocol}`. ([#3675](https://github.com/matrix-org/matrix-doc/issues/3675))


-### Identity Service API
+## Identity Service API


 <strong>Backwards Compatible Changes</strong>
@ -114,7 +119,7 @@ Variables:
 - Fix the rendering of the responses for various API endpoints. ([#3674](https://github.com/matrix-org/matrix-doc/issues/3674))


-### Push Gateway API
+## Push Gateway API


 <strong>Spec Clarifications</strong>
@ -123,7 +128,7 @@ Variables:
 - Fix the rendering of the responses for various API endpoints. ([#3674](https://github.com/matrix-org/matrix-doc/issues/3674))


-### Room Versions
+## Room Versions


 <strong>Backwards Compatible Changes</strong>
@ -144,7 +149,7 @@ Variables:
 - Fix auth rules to allow membership of `knock` -> `leave` in v7, v8, and v9. ([#3694](https://github.com/matrix-org/matrix-doc/issues/3694))


-### Appendices
+## Appendices


 <strong>Backwards Compatible Changes</strong>
--- a/content/changelog/v1.3.md
+++ b/content/changelog/v1.3.md
@ -1,4 +1,10 @@
 ---
+title: v1.3 Changelog
+linkTitle: v1.3
+type: docs
+outputs:
+  - html
+  - checklist
 date: 2022-06-15T00:00:00+0100
 ---
 <!--
@ -9,15 +15,14 @@ Variables:
    June 15, 2022     = Replaced by the date (eg: April 01, 2021)
 -->

-## v1.3
-
 <table class="release-info">
 <tr><th>Git commit</th><td><a href="https://github.com/matrix-org/matrix-spec/tree/v1.3">https://github.com/matrix-org/matrix-spec/tree/v1.3</a></td>
 <tr><th>Release date</th><td>June 15, 2022</td>
+<tr><th>Checklist</th><td><a href="/changelog/v1.3/checklist.md">checklist.md</a></td>
 </table>

 <!-- Intentionally blank line to ensure headers work in the concatenated changelog -->
-### Client-Server API
+## Client-Server API


 <strong>Deprecations</strong>
@ -55,7 +60,7 @@ Variables:
 - Fix membership state transitions to denote that `invite->knock` and `external->leave` are valid transitions. ([#3730](https://github.com/matrix-org/matrix-spec-proposals/issues/3730))


-### Server-Server API
+## Server-Server API


 <strong>Backwards Compatible Changes</strong>
@ -79,7 +84,7 @@ Variables:
 - Clarify that the `content` for `X-Matrix` signature validation is the parsed JSON body. ([#3727](https://github.com/matrix-org/matrix-spec-proposals/issues/3727))


-### Application Service API
+## Application Service API


 <strong>Backwards Compatible Changes</strong>
@ -88,19 +93,19 @@ Variables:
 - Add timestamp massaging as per [MSC3316](https://github.com/matrix-org/matrix-spec-proposals/pull/3316). ([#1094](https://github.com/matrix-org/matrix-spec/issues/1094))


-### Identity Service API
+## Identity Service API


 No significant changes.


-### Push Gateway API
+## Push Gateway API


 No significant changes.


-### Room Versions
+## Room Versions


 <strong>Backwards Compatible Changes</strong>
@ -124,7 +129,7 @@ No significant changes.
 - For room versions 7, 8, 9, and 10: fix join membership authorization rules when `join_rule` is `knock`. ([#3737](https://github.com/matrix-org/matrix-spec-proposals/issues/3737))


-### Appendices
+## Appendices


 No significant changes.
--- a/content/changelog/v1.4.md
+++ b/content/changelog/v1.4.md
@ -1,4 +1,10 @@
 ---
+title: v1.4 Changelog
+linkTitle: v1.4
+type: docs
+outputs:
+  - html
+  - checklist
 date: 2022-09-29T00:00:00+0100
 ---
 <!--
@ -9,15 +15,14 @@ Variables:
    September 29, 2022     = Replaced by the date (eg: April 01, 2021)
 -->

-## v1.4
-
 <table class="release-info">
 <tr><th>Git commit</th><td><a href="https://github.com/matrix-org/matrix-spec/tree/v1.4">https://github.com/matrix-org/matrix-spec/tree/v1.4</a></td>
 <tr><th>Release date</th><td>September 29, 2022</td>
+<tr><th>Checklist</th><td><a href="/changelog/v1.4/checklist.md">checklist.md</a></td>
 </table>

 <!-- Intentionally blank line to ensure headers work in the concatenated changelog -->
-### Client-Server API
+## Client-Server API


 <strong>Removed Endpoints</strong>
@ -58,7 +63,7 @@ Variables:
 - Clarify enum values by separating possible values with commas. ([#1240](https://github.com/matrix-org/matrix-spec/issues/1240))


-### Server-Server API
+## Server-Server API


 <strong>Backwards Compatible Changes</strong>
@ -75,7 +80,7 @@ Variables:
 - Update "API Standards" section to clarify how JSON is used. ([#1185](https://github.com/matrix-org/matrix-spec/issues/1185))


-### Application Service API
+## Application Service API


 <strong>Breaking Changes</strong>
@ -90,7 +95,7 @@ Variables:
 - Add HTML anchors for object definitions in the formatted specification. ([#1174](https://github.com/matrix-org/matrix-spec/issues/1174))


-### Identity Service API
+## Identity Service API


 <strong>Spec Clarifications</strong>
@ -100,7 +105,7 @@ Variables:
 - Update "API Standards" section to clarify how JSON is used. ([#1185](https://github.com/matrix-org/matrix-spec/issues/1185))


-### Push Gateway API
+## Push Gateway API


 <strong>Spec Clarifications</strong>
@ -109,7 +114,7 @@ Variables:
 - Add HTML anchors for object definitions in the formatted specification. ([#1174](https://github.com/matrix-org/matrix-spec/issues/1174))


-### Room Versions
+## Room Versions


 <strong>Spec Clarifications</strong>
@ -120,13 +125,13 @@ Variables:
 - For room versions 7 through 10: Clarify that `invite->knock` is actually a legal transition. ([#1175](https://github.com/matrix-org/matrix-spec/issues/1175))


-### Appendices
+## Appendices


 No significant changes.


-### Internal Changes/Tooling
+## Internal Changes/Tooling


 <strong>Backwards Compatible Changes</strong>
--- a/content/changelog/v1.5.md
+++ b/content/changelog/v1.5.md
@ -1,4 +1,10 @@
 ---
+title: v1.5 Changelog
+linkTitle: v1.5
+type: docs
+outputs:
+  - html
+  - checklist
 date: 2022-11-17T08:22:11-07:00
 ---
 <!--
@ -9,15 +15,14 @@ Variables:
    November 17, 2022     = Replaced by the date (eg: April 01, 2021)
 -->

-## v1.5
-
 <table class="release-info">
 <tr><th>Git commit</th><td><a href="https://github.com/matrix-org/matrix-spec/tree/v1.5">https://github.com/matrix-org/matrix-spec/tree/v1.5</a></td>
 <tr><th>Release date</th><td>November 17, 2022</td>
+<tr><th>Checklist</th><td><a href="/changelog/v1.5/checklist.md">checklist.md</a></td>
 </table>

 <!-- Intentionally blank line to ensure headers work in the concatenated changelog -->
-### Client-Server API
+## Client-Server API


 <strong>Backwards Compatible Changes</strong>
@ -45,7 +50,7 @@ Variables:
 - Add example read receipt to `GET /_matrix/client/v3/sync` response example. ([#1341](https://github.com/matrix-org/matrix-spec/issues/1341))


-### Server-Server API
+## Server-Server API


 <strong>Spec Clarifications</strong>
@ -54,7 +59,7 @@ Variables:
 - Fix a number of broken links in the specification. ([#1330](https://github.com/matrix-org/matrix-spec/issues/1330))


-### Application Service API
+## Application Service API


 <strong>Spec Clarifications</strong>
@ -63,7 +68,7 @@ Variables:
 - Clarify that application services can only register an interest in local users, as per [MSC3905](https://github.com/matrix-org/matrix-spec-proposals/issues/3905). ([#1305](https://github.com/matrix-org/matrix-spec/issues/1305))


-### Identity Service API
+## Identity Service API


 <strong>Spec Clarifications</strong>
@ -72,13 +77,13 @@ Variables:
 - Fix a number of broken links in the specification. ([#1330](https://github.com/matrix-org/matrix-spec/issues/1330))


-### Push Gateway API
+## Push Gateway API


 No significant changes.


-### Room Versions
+## Room Versions


 <strong>Spec Clarifications</strong>
@ -89,13 +94,13 @@ No significant changes.
 - Fix a number of broken links in the specification. ([#1330](https://github.com/matrix-org/matrix-spec/issues/1330))


-### Appendices
+## Appendices


 No significant changes.


-### Internal Changes/Tooling
+## Internal Changes/Tooling


 <strong>Backwards Compatible Changes</strong>
--- a/content/changelog/v1.6.md
+++ b/content/changelog/v1.6.md
@ -1,4 +1,10 @@
 ---
+title: v1.6 Changelog
+linkTitle: v1.6
+type: docs
+outputs:
+  - html
+  - checklist
 date: 2023-02-14T08:25:40-07:00
 ---
 <!--
@ -9,15 +15,14 @@ Variables:
    February 14, 2023     = Replaced by the date (eg: April 01, 2021)
 -->

-## v1.6
-
 <table class="release-info">
 <tr><th>Git commit</th><td><a href="https://github.com/matrix-org/matrix-spec/tree/v1.6">https://github.com/matrix-org/matrix-spec/tree/v1.6</a></td>
 <tr><th>Release date</th><td>February 14, 2023</td>
+<tr><th>Checklist</th><td><a href="/changelog/v1.6/checklist.md">checklist.md</a></td>
 </table>

 <!-- Intentionally blank line to ensure headers work in the concatenated changelog -->
-### Client-Server API
+## Client-Server API


 <strong>Backwards Compatible Changes</strong>
@ -45,7 +50,7 @@ Variables:
 - Improve distinction between tags and their attributes in the rich text section. Contributed by Nico. ([#1433](https://github.com/matrix-org/matrix-spec/issues/1433))


-### Server-Server API
+## Server-Server API


 <strong>Breaking Changes</strong>
@ -73,7 +78,7 @@ Variables:
 - Fix `edu_type` in EDU examples. ([#1383](https://github.com/matrix-org/matrix-spec/issues/1383))


-### Application Service API
+## Application Service API


 <strong>Backwards Compatible Changes</strong>
@ -82,7 +87,7 @@ Variables:
 - Add information on standard error responses for unknown endpoints/methods, as per [MSC3743](https://github.com/matrix-org/matrix-spec-proposals/pull/3743). ([#1347](https://github.com/matrix-org/matrix-spec/issues/1347))


-### Identity Service API
+## Identity Service API


 <strong>Backwards Compatible Changes</strong>
@ -91,7 +96,7 @@ Variables:
 - Add information on standard error responses for unknown endpoints/methods, as per [MSC3743](https://github.com/matrix-org/matrix-spec-proposals/pull/3743). ([#1347](https://github.com/matrix-org/matrix-spec/issues/1347))


-### Push Gateway API
+## Push Gateway API


 <strong>Backwards Compatible Changes</strong>
@ -100,7 +105,7 @@ Variables:
 - Add information on standard error responses for unknown endpoints/methods, as per [MSC3743](https://github.com/matrix-org/matrix-spec-proposals/pull/3743). ([#1347](https://github.com/matrix-org/matrix-spec/issues/1347))


-### Room Versions
+## Room Versions


 <strong>Backwards Compatible Changes</strong>
@ -116,13 +121,13 @@ Variables:
 - Fix various typos throughout the specification. ([#1423](https://github.com/matrix-org/matrix-spec/issues/1423))


-### Appendices
+## Appendices


 No significant changes.


-### Internal Changes/Tooling
+## Internal Changes/Tooling


 <strong>Spec Clarifications</strong>
--- a/content/changelog/v1.7.md
+++ b/content/changelog/v1.7.md
@ -1,4 +1,10 @@
 ---
+title: v1.7 Changelog
+linkTitle: v1.7
+type: docs
+outputs:
+  - html
+  - checklist
 date: 2023-05-25T09:47:21-06:00
 ---
 <!--
@ -9,15 +15,14 @@ Variables:
    May 25, 2023     = Replaced by the date (eg: April 01, 2021)
 -->

-## v1.7
-
 <table class="release-info">
 <tr><th>Git commit</th><td><a href="https://github.com/matrix-org/matrix-spec/tree/v1.7">https://github.com/matrix-org/matrix-spec/tree/v1.7</a></td>
 <tr><th>Release date</th><td>May 25, 2023</td>
+<tr><th>Checklist</th><td><a href="/changelog/v1.7/checklist.md">checklist.md</a></td>
 </table>

 <!-- Intentionally blank line to ensure headers work in the concatenated changelog -->
-### Client-Server API
+## Client-Server API


 <strong>New Endpoints</strong>
@ -63,7 +68,7 @@ Variables:
 - Add missing `knock_restricted` join rule to the `m.room.join_rules` schema. ([#1535](https://github.com/matrix-org/matrix-spec/issues/1535))


-### Server-Server API
+## Server-Server API


 <strong>Spec Clarifications</strong>
@ -75,7 +80,7 @@ Variables:
 - Remove extraneous `age_ts` field from the reference hash calculation section. ([#1536](https://github.com/matrix-org/matrix-spec/issues/1536))


-### Application Service API
+## Application Service API


 <strong>New Endpoints</strong>
@ -97,7 +102,7 @@ Variables:
 - Fix various typos throughout the specification. ([#1447](https://github.com/matrix-org/matrix-spec/issues/1447))


-### Identity Service API
+## Identity Service API


 <strong>Spec Clarifications</strong>
@ -106,13 +111,13 @@ Variables:
 - Corrections to the response format of `/_matrix/identity/v2/store-invite`. ([#1486](https://github.com/matrix-org/matrix-spec/issues/1486))


-### Push Gateway API
+## Push Gateway API


 No significant changes.


-### Room Versions
+## Room Versions


 <strong>Spec Clarifications</strong>
@ -121,7 +126,7 @@ No significant changes.
 - Clarifications of event ID formats in early room versions ([#1484](https://github.com/matrix-org/matrix-spec/issues/1484))


-### Appendices
+## Appendices


 <strong>Spec Clarifications</strong>
@ -132,7 +137,7 @@ No significant changes.
 - Clarifications of event ID formats in early room versions. ([#1484](https://github.com/matrix-org/matrix-spec/issues/1484))


-### Internal Changes/Tooling
+## Internal Changes/Tooling


 <strong>Spec Clarifications</strong>
--- a/content/changelog/v1.8.md
+++ b/content/changelog/v1.8.md
@ -1,4 +1,10 @@
 ---
+title: v1.8 Changelog
+linkTitle: v1.8
+type: docs
+outputs:
+  - html
+  - checklist
 date: 2023-08-23T09:23:53-06:00
 ---
 <!--
@ -9,16 +15,15 @@ Variables:
    August 23, 2023     = Replaced by the date (eg: April 01, 2021)
 -->

-## v1.8
-
 <table class="release-info">
 <tr><th>Git commit</th><td><a href="https://github.com/matrix-org/matrix-spec/tree/v1.8">https://github.com/matrix-org/matrix-spec/tree/v1.8</a></td>
 <tr><th>Release date</th><td>August 23, 2023</td>
+<tr><th>Checklist</th><td><a href="/changelog/v1.8/checklist.md">checklist.md</a></td>
 </table>

 <!-- Intentionally blank line to ensure headers work in the concatenated changelog -->

-### Client-Server API
+## Client-Server API

 **Backwards Compatible Changes**

@ -36,7 +41,7 @@ Variables:
 - Fix various typos throughout the specification. ([#1597](https://github.com/matrix-org/matrix-spec/issues/1597))


-### Server-Server API
+## Server-Server API

 **Deprecations**

@ -58,26 +63,26 @@ Variables:
 - Switch to ordered list for server name resolution steps. ([#1623](https://github.com/matrix-org/matrix-spec/issues/1623))


-### Application Service API
+## Application Service API

 **Spec Clarifications**

 - Fix type of custom `fields` in thirdparty lookup queries. ([#1584](https://github.com/matrix-org/matrix-spec/issues/1584))


-### Identity Service API
+## Identity Service API

 **Spec Clarifications**

 - Make sure examples types match schema in definitions. ([#1563](https://github.com/matrix-org/matrix-spec/issues/1563))


-### Push Gateway API
+## Push Gateway API

 No significant changes.


-### Room Versions
+## Room Versions

 **Backwards Compatible Changes**

@ -88,7 +93,7 @@ No significant changes.
 - Update the redaction rules in room version 11, as per [MSC2176](https://github.com/matrix-org/matrix-spec-proposals/pull/2176) and [MSC3821](https://github.com/matrix-org/matrix-spec-proposals/pull/3821). ([#1604](https://github.com/matrix-org/matrix-spec/issues/1604))


-### Appendices
+## Appendices

 **Backwards Compatible Changes**

@ -99,7 +104,7 @@ No significant changes.
 - Clarify spec re canonical JSON to handle negative-zero; also, give an example of negative-zero and a large power of ten. ([#1573](https://github.com/matrix-org/matrix-spec/issues/1573))


-### Internal Changes/Tooling
+## Internal Changes/Tooling

 **Backwards Compatible Changes**

--- a/content/changelog/v1.9.md
+++ b/content/changelog/v1.9.md
@ -1,4 +1,10 @@
 ---
+title: v1.9 Changelog
+linkTitle: v1.9
+type: docs
+outputs:
+  - html
+  - checklist
 date: 2023-11-29T10:04:26-07:00
 ---
 <!--
@ -9,16 +15,15 @@ Variables:
    November 29, 2023     = Replaced by the date (eg: April 01, 2021)
 -->

-## v1.9
-
 <table class="release-info">
 <tr><th>Git commit</th><td><a href="https://github.com/matrix-org/matrix-spec/tree/v1.9">https://github.com/matrix-org/matrix-spec/tree/v1.9</a></td>
 <tr><th>Release date</th><td>November 29, 2023</td>
+<tr><th>Checklist</th><td><a href="/changelog/v1.9/checklist.md">checklist.md</a></td>
 </table>

 <!-- Intentionally blank line to ensure headers work in the concatenated changelog -->

-### Client-Server API
+## Client-Server API

 **Backwards Compatible Changes**

@ -38,7 +43,7 @@ Variables:
 - Clarify that thread roots are not considered within the thread. ([#1677](https://github.com/matrix-org/matrix-spec/issues/1677))


-### Server-Server API
+## Server-Server API

 **Spec Clarifications**

@ -47,27 +52,27 @@ Variables:
 - Clarify that federation requests for non-local users are invalid. ([#1672](https://github.com/matrix-org/matrix-spec/issues/1672))


-### Application Service API
+## Application Service API

 No significant changes.


-### Identity Service API
+## Identity Service API

 No significant changes.


-### Push Gateway API
+## Push Gateway API

 No significant changes.


-### Room Versions
+## Room Versions

 No significant changes.


-### Appendices
+## Appendices

 **Spec Clarifications**

@ -75,7 +80,7 @@ No significant changes.
 - Fix various typos throughout the specification. ([#1652](https://github.com/matrix-org/matrix-spec/issues/1652))


-### Internal Changes/Tooling
+## Internal Changes/Tooling

 **Backwards Compatible Changes**

--- a/layouts/_default/single.checklist.md
+++ b/layouts/_default/single.checklist.md
@ -0,0 +1,4 @@
+{{ .RawContent
+    | replaceRE "\n- " "\n- [ ] "
+    | replaceRE "<!--(.|\\s)*?-->\n?" ""
+    | replaceRE "<tr><th>Checklist.*\n" "" }}
--- a/layouts/shortcodes/changelog/changelog-description.html
+++ b/layouts/shortcodes/changelog/changelog-description.html
@ -1,19 +0,0 @@
-{{/*
-
-  This template is used to provide different content for the unstable spec
-  version and for a versioned release.
-
-*/}}
-
-{{ $status := .Site.Params.version.status }}
-
-{{ if eq $status "unstable"}}
-
-<p>This is the <strong>unstable</strong> version of the Matrix specification.</p>
-<p>This changelog lists changes made since the last release of the specification.</p>
-
-{{ else }}
-
-<p>This is version <strong>v{{ .Site.Params.version.major }}.{{ .Site.Params.version.minor }}</strong> of the Matrix specification.</p>
-
-{{ end }}
--- a/layouts/shortcodes/changelog/changelogs.html
+++ b/layouts/shortcodes/changelog/changelogs.html
@ -1,10 +1,8 @@
 {{/*
-   This template is used to render all of the changelog sections under
-   "content/changelogs"
+   This template is used to redirect the changelog section under
+   "content/changelogs" to the latest version's changelog page.
 */}}

-{{ with .Page.Resources.Match "*.md" }}
-{{ range ((sort . "Params.date" "desc")) }}
-{{ .RenderShortcodes }}
-{{ end }}
+{{ with index .Page.RegularPages.ByDate.Reverse 0 }}
+   <meta http-equiv="refresh" content="0; url={{ .Permalink }}" />
 {{ end }}
--- a/scripts/generate-changelog.sh
+++ b/scripts/generate-changelog.sh
@ -16,24 +16,38 @@ rm -f rendered.md
 # Generate changelog
 towncrier --yes

+if [ "$VERSION" = "vUNSTABLE" ]; then
+    TITLE="Changes since last release"
+    LINKTITLE="Unstable"
+    FILENAME="unstable.md"
+else
+    TITLE="$VERSION Changelog"
+    LINKTITLE="$VERSION"
+    FILENAME="$VERSION.md"
+fi
+
 {
    # Prepare the header
    # We include the generation date in the front matter so that we can use it
    # to sort the changelogs at build time.
    cat <<EOF
 ---
+title: $TITLE
+linkTitle: $LINKTITLE
+type: docs
+outputs:
+  - html
+  - checklist
 date: $(date -Iseconds)
 ---
 EOF
-    if [ "$VERSION" = "vUNSTABLE" ]; then
-        echo "## Changes since last release"
-    else
+    if [ "$VERSION" != "vUNSTABLE" ]; then
        sed -e "s/VERSION/$1/g" -e "s/DATE/$2/g" header.md
    fi

    # Remove trailing whitespace (such as our intentionally blank RST headings)
    sed -e "s/[ ]*$//" rendered.md
-} > ../content/changelog/$VERSION.md
+} > ../content/changelog/$FILENAME

 # Cleanup
 rm -v rendered.md
				`@ -0,0 +1 @@`
				Provide markdown checklists for changelogs under `/changelog/$VERSION/checklist.md`.