mirror of
https://github.com/matrix-org/matrix-spec
synced 2025-12-25 10:28:37 +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.
116 lines
3.4 KiB
YAML
116 lines
3.4 KiB
YAML
targets:
|
|
index:
|
|
files:
|
|
- index.rst
|
|
client_server:
|
|
files:
|
|
- client_server_api.rst
|
|
- { 1: events.rst }
|
|
- { 1: modules.rst }
|
|
- { 2: feature_profiles.rst }
|
|
- { 2: "group:modules" } # reference a group of files
|
|
version_label: "%CLIENT_RELEASE_LABEL%"
|
|
application_service:
|
|
files:
|
|
- application_service_api.rst
|
|
version_label: "%APPSERVICE_RELEASE_LABEL%"
|
|
server_server:
|
|
files:
|
|
- server_server_api.rst
|
|
version_label: "%SERVER_RELEASE_LABEL%"
|
|
identity_service:
|
|
files:
|
|
- identity_service_api.rst
|
|
version_label: "%IDENTITY_RELEASE_LABEL%"
|
|
push_gateway:
|
|
files:
|
|
- push_gateway.rst
|
|
version_label: "%PUSH_GATEWAY_RELEASE_LABEL%"
|
|
rooms:
|
|
files:
|
|
- rooms/intro.rst
|
|
|
|
# TODO: Switch this back to unstable.rst after releasing rooms v2
|
|
# We temporarily do this so that "unstable" points to the in-dev
|
|
# version, however we may also want to hardlink to v2 in places and
|
|
# thus we maintain a v2 version of the same doc.
|
|
#
|
|
# See meta/releasing-rooms-v2.md
|
|
|
|
#- rooms/unstable.rst
|
|
- rooms/v2.rst
|
|
version_label: unstable
|
|
rooms@v1: # this is translated to be rooms/v1.html
|
|
files:
|
|
- rooms/intro.rst
|
|
- rooms/v1.rst
|
|
version_label: v1
|
|
rooms@v2: # this is translated to be rooms/v2.html
|
|
files:
|
|
- rooms/intro.rst
|
|
- rooms/v2.rst
|
|
version_label: v2
|
|
rooms@latest: # this is translated to be rooms/latest.html
|
|
files:
|
|
- rooms/intro.rst
|
|
- rooms/v1.rst # TODO: Find a better way to link to the v2 spec
|
|
version_label: latest
|
|
appendices:
|
|
files:
|
|
- appendices.rst
|
|
- appendices/base64.rst
|
|
- appendices/signing_json.rst
|
|
- appendices/identifier_grammar.rst
|
|
- appendices/threepids.rst
|
|
- appendices/threat_model.rst
|
|
- appendices/test_vectors.rst
|
|
proposals:
|
|
files:
|
|
- proposals_intro.rst
|
|
- proposals.rst
|
|
groups: # reusable blobs of files when prefixed with 'group:'
|
|
modules:
|
|
- modules/instant_messaging.rst
|
|
- modules/voip_events.rst
|
|
- modules/typing_notifications.rst
|
|
- modules/receipts.rst
|
|
- modules/read_markers.rst
|
|
- modules/presence.rst
|
|
- modules/content_repo.rst
|
|
- modules/send_to_device.rst
|
|
- modules/device_management.rst
|
|
- modules/end_to_end_encryption.rst
|
|
- modules/history_visibility.rst
|
|
- modules/push.rst
|
|
- modules/third_party_invites.rst
|
|
- modules/search.rst
|
|
- modules/guest_access.rst
|
|
- modules/room_previews.rst
|
|
- modules/tags.rst
|
|
- modules/account_data.rst
|
|
- modules/admin.rst
|
|
- modules/event_context.rst
|
|
- modules/cas_login.rst
|
|
- modules/dm.rst
|
|
- modules/ignore_users.rst
|
|
- modules/stickers.rst
|
|
- modules/report_content.rst
|
|
- modules/third_party_networks.rst
|
|
- modules/openid.rst
|
|
- modules/server_acls.rst
|
|
- modules/mentions.rst
|
|
|
|
|
|
title_styles: ["=", "-", "~", "+", "^", "`", "@", ":"]
|
|
|
|
# The templating system doesn't know the right title style to use when generating
|
|
# RST. These symbols are 'relative' to say "make a sub-title" (-1), "make a title
|
|
# at the same level (0)", or "make a title one above (+1)". The gendoc script
|
|
# will inspect this file and replace these relative styles with actual title
|
|
# styles. The templating system will also inspect this file to know which symbols
|
|
# to inject.
|
|
relative_title_styles:
|
|
subtitle: "<"
|
|
sametitle: "/"
|
|
supertitle: ">"
|