matrix-spec/changelogs
Travis Ralston d4c74d37a9
Update documentation style & fix room version heading order (#3683)
* Update documentation style & fix room version heading order

Also add a missing signing key section to v6.

This additionally contains various edits to the fragments to have them make a little bit more sense in context.

Finally, this updates various aspects of the documentation style which haven't previously been considered - they're added here considering we're in the area.

* changelog

* enhanced changelogs

* Minor wording adjustments

* Apply suggestions from code review

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

Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
2022-01-31 15:18:58 -07:00
..
appendices/newsfragments Add a changelog for the appendices (#3609) 2022-01-04 20:23:02 -07:00
application_service/newsfragments Changelogs for #3674 2022-01-26 11:00:30 +00:00
client_server/newsfragments Update several spots where C-S API was still using r0 APIs (#3671) 2022-01-31 17:19:56 +00:00
identity_service/newsfragments Changelogs for #3674 2022-01-26 11:00:30 +00:00
legacy Add GitHub Action to check spelling (#3591) 2021-12-28 09:17:49 -07:00
push_gateway/newsfragments Changelogs for #3674 2022-01-26 11:00:30 +00:00
room_versions/newsfragments Update documentation style & fix room version heading order (#3683) 2022-01-31 15:18:58 -07:00
server_server/newsfragments Changelogs for #3674 2022-01-26 11:00:30 +00:00
header.md Release process: changelog generation and docs (#3446) 2021-10-18 10:09:35 -06:00
pyproject.toml Release process: changelog generation and docs (#3446) 2021-10-18 10:09:35 -06:00
README.md Release process: changelog generation and docs (#3446) 2021-10-18 10:09:35 -06: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.