docs-matrix-spec/changelogs
David Baker 848c1e0348
Spec for MSC3981 (#1746)
* Spec for MSC3981

This writes up https://github.com/matrix-org/matrix-spec-proposals/pull/3981

Hopefully this is relatively straightforward, apart from having to add
the parameters and response field in all three places. I tried to factor
these out but it seems references just aren't supported in the right
places currently (see https://github.com/matrix-org/matrix-spec/pull/1745
for my efforts). Path parameters can't be optional, so it can't be done
that way either.

* Missed schemas

* newsfile

* Actually it clearly isn't going to support markdown, is it?

* grammar

Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>

* grammar

Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>

* Clarity

Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>

* Clarity

Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>

* Typo

Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>

* More clarity.

Note this is counter what the MSC actually proposed to add, but
I think it's clear that this is what it meant.

---------

Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
2024-03-19 18:12:32 +00:00
..
appendices/newsfragments Matrix 1.9 2023-11-29 10:05:20 -07:00
application_service/newsfragments Specify that appservice login and register fail on incorrect as_tokens (#1744) 2024-03-19 14:59:00 +00:00
client_server/newsfragments Spec for MSC3981 (#1746) 2024-03-19 18:12:32 +00:00
identity_service/newsfragments Matrix 1.8 changelog 2023-08-23 09:24:08 -06:00
internal/newsfragments Factor out all the common parameters of the various /relations apis (#1745) 2024-03-19 17:03:44 +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 Clarify that invite->knock is not a valid transition (#1717) 2024-02-21 14:16:40 -07:00
server_server/newsfragments Disambiguate uses of PublicRoomsChunk` (#1740) 2024-03-06 19:48:09 -05: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.