matrix-spec/changelogs/rooms.rst

.. version: v2

.. Note: We set the version as "version 2" so that we can maintain a specific version
.. variable in the changelog. We already know the next version is going to be v2, so
.. this makes it easier to copy/paste unstable.rst to v2.rst

Room version 1
==============
.. version: v1

This is the first iteration of rooms in Matrix.
Add a room version specification The "Room Specification" (or "Room Version Specification") is the specification that defines which room versions do what and are intended to be documents which speak the truth about how rooms operate under the hood. The approach taken here is a bit different than other specifications. For starters, the specification is versioned in this project instead of relying on the matrix.org repository to track compiled HTML. This is done for a couple reasons, the first being we're still developing the v1 specification while concurrently making a v2 spec and the second being trying to reduce the reliance on matrix.org's repository for specifications. Because the room spec is built into versions, some changes needed to be made. The `targets.yaml` now has a special syntax for indicating what version something is at, and the changelog generator can handle rendering different versions of the same changelog (as parsed from the RST). Some additional work has been put in to the changelog parsing to allow us to reference the v1 room spec as "v1" without having to sacrifice clarity in the changelog headings. Finally, this moves the state resolution algorithms into the versioned spec as a result of MSC1759 (https://github.com/matrix-org/matrix-doc/pull/1759). Note: this does not introduce the concept of versioned schemas (tabs) that I was previously working with. There's currently no use for them, so they are shelved elsewhere. 2018-09-11 00:29:30 +02:00			`.. version: v2`

			`.. Note: We set the version as "version 2" so that we can maintain a specific version`
			`.. variable in the changelog. We already know the next version is going to be v2, so`
			`.. this makes it easier to copy/paste unstable.rst to v2.rst`

			`Room version 1`
			`==============`
			`.. version: v1`

			`This is the first iteration of rooms in Matrix.`