docs-matrix-spec/changelogs
Kévin Commaille 3af77f0cb4
Fix the table of content for room versions (#1884)
* Fix ToC for room versions pages

Like for the cs-module shortcode, use .RenderShortcodes
instead of .Content for the rver-fragment shortcode,
so the headings are detected by Hugo.

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

* Change the way "this version" is detected in added-in and changed-in shortcodes

Now that we use .RenderShortcodes in the rver-fragment shortcode,
we cannot remove the output of these shortcodes dynamically
because they are replaced by a temporary placeholder due to Hugo's internals.

Instead, since the `this` parameter was only used for room version,
we always use the `v` parameter and compare with the version
provided in the page's front matter.

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

* Add changelog

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

* Add version front matter for v11

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

* Update changelogs/room_versions/newsfragments/1884.clarification

---------

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
Co-authored-by: Travis Ralston <travpc@gmail.com>
2024-06-20 15:47:09 +00:00
..
appendices/newsfragments Move size limits for user, room and event IDs into the appendix and clarify that the length is to be measured in bytes (#1850) 2024-06-12 09:11:07 +01:00
application_service/newsfragments Normalize the changelog for Matrix 1.11 2024-06-19 21:52:21 -06:00
client_server/newsfragments Normalize the changelog for Matrix 1.11 2024-06-19 21:52:21 -06:00
identity_service/newsfragments Normalize the changelog for Matrix 1.11 2024-06-19 21:52:21 -06:00
internal/newsfragments Allow to specify a prefix for generated HTML IDs of API endpoints (#1882) 2024-06-20 15:39:50 +00:00
legacy Add a hyphen between third and party when used as an adjective (#1447) 2023-03-08 09:58:29 +00:00
push_gateway/newsfragments Matrix 1.6 2023-02-14 08:26:14 -07:00
room_versions/newsfragments Fix the table of content for room versions (#1884) 2024-06-20 15:47:09 +00:00
server_server/newsfragments Normalize the changelog for Matrix 1.11 2024-06-19 21:52:21 -06:00
header.md Fix broken links to matrix-doc (#1032) 2022-04-20 16:36:14 +01:00
pyproject.toml Fix rendered changelog with new version of towncrier (#1598) 2023-07-18 17:52:38 +01:00
README.md Release process: changelog generation and docs (#3446) 2021-10-18 10:09:35 -06:00
template.md.jinja Fix rendered changelog with new version of towncrier (#1598) 2023-07-18 17:52:38 +01:00

Changelogs

Towncrier is used to manage the changelog and keep it up to date. Because of this, updating a changelog is really easy.

Generating the changelog

Please see the release docs for more information.

Creating a new changelog

There are a few places you'll have to update:

  • /layouts/shortcodes/changelog/changelog-changes.html to account for the new changelog.
  • /scripts/generate-changelog.sh to render the changelog for releases.
  • Supporting documentation such as the contributing guidelines.