mirror of
https://github.com/matrix-org/matrix-spec
synced 2026-01-09 17:33:44 +01:00
ffe577371d
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.
55 lines
1.8 KiB
ReStructuredText
55 lines
1.8 KiB
ReStructuredText
.. Copyright 2018 New Vector Ltd
|
|
..
|
|
.. Licensed under the Apache License, Version 2.0 (the "License");
|
|
.. you may not use this file except in compliance with the License.
|
|
.. You may obtain a copy of the License at
|
|
..
|
|
.. http://www.apache.org/licenses/LICENSE-2.0
|
|
..
|
|
.. Unless required by applicable law or agreed to in writing, software
|
|
.. distributed under the License is distributed on an "AS IS" BASIS,
|
|
.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
.. See the License for the specific language governing permissions and
|
|
.. limitations under the License.
|
|
|
|
|
|
.. DEV NOTE: This is stubbed as a template and not actually used anywhere.
|
|
.. See v2.rst for the "unstable" room version, which is currently under
|
|
.. development.
|
|
..
|
|
.. See meta/releasing-rooms-v2.md
|
|
|
|
|
|
.. Note: This document appended to the end of the intro, so this next line
|
|
.. appears under "Other Room Versions".
|
|
|
|
.. Warning::
|
|
|
|
This is the specification for unreleased changes to rooms. The stability
|
|
of rooms using this specification cannot be guaranteed.
|
|
|
|
|
|
Changelog
|
|
---------
|
|
|
|
.. topic:: unstable
|
|
{{rooms_changelog_unstable}}
|
|
|
|
This version of the specification is generated from
|
|
`matrix-doc <https://github.com/matrix-org/matrix-doc>`_ as of Git commit
|
|
`{{git_version}} <https://github.com/matrix-org/matrix-doc/tree/{{git_rev}}>`_.
|
|
|
|
For the full historical changelog, see
|
|
https://github.com/matrix-org/matrix-doc/blob/master/changelogs/rooms.rst
|
|
|
|
|
|
Some Module
|
|
-----------
|
|
|
|
Lorem ipsum dolor sit amet, consectetur adipiscing elit. In sit amet
|
|
eros turpis. Quisque commodo diam vel massa ultrices, vel egestas eros
|
|
dignissim. Sed sit amet lacus eget metus auctor malesuada at ut odio.
|
|
In turpis leo, viverra et mi porttitor, condimentum bibendum dolor.
|
|
|
|
.. {-{versioned_test_definition}-}
|