docs-matrix-spec/changelogs
Kévin Commaille b1f66d1b71
Improve the JS script to highlight the current ToC entry (#1991)
The code relied on an IntersectionOberver, so the ToC was only updated when a heading was in the viewport.
It meant that if we jumped to a part of the text that has no heading, the ToC would still point to the old entry.

The new code looks for the correct heading when the view is scrolled so the correct entry is always selected.

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2024-11-12 22:53:46 +00:00
..
appendices/newsfragments Remove note about reference implementations (#1966) 2024-10-10 14:10:55 +01:00
application_service/newsfragments v1.12 changelog 2024-10-07 13:32:17 -06:00
client_server/newsfragments Clarify parameter definition for third-party location lookups (#1947) 2024-11-12 22:24:20 +00:00
identity_service/newsfragments v1.12 changelog 2024-10-07 13:32:17 -06:00
internal/newsfragments Improve the JS script to highlight the current ToC entry (#1991) 2024-11-12 22:53:46 +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 Clarify that pusher URLs have a fixed path (#1974) 2024-11-07 14:56:53 +00:00
room_versions/newsfragments v1.12 changelog 2024-10-07 13:32:17 -06:00
server_server/newsfragments Add 403 error response to federation/v1/state_ids (#1926) 2024-10-30 10:30:05 +00:00
header.md Provide MD checklists for the changelog (#1937) 2024-09-27 13:00:00 +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 Provide MD checklists for the changelog (#1937) 2024-09-27 13:00:00 +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.