Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2026-01-08 08:53:43 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
5362 commits 28 branches 42 tags 32 MiB
Commit graph

31 commits

Author SHA1 Message Date
Travis Ralston 734be5165b
Apply suggestions from code review 
Co-authored-by: Kitsune Ral <Kitsune-Ral@users.sf.net>
 2020-12-04 14:46:11 -07:00
Philipp Emanuel Weidmann aab2d587f3
Fix spelling and grammar issues 
Signed-off-by: Philipp Emanuel Weidmann <pew@worldwidemann.com>
 2020-12-04 11:32:55 +05:30
Travis Ralston e9998c5335 Clarify that server names are at least 1 character 
Fixes https://github.com/matrix-org/matrix-doc/issues/2460
 2020-05-25 12:21:27 -06:00
Travis Ralston 18eca90022 Exclude DEL from historical user IDs 
The range is inclusive, so don't include 7F
 2019-06-12 13:48:50 -06:00
Travis Ralston ad2eefdde9 Shuffle and clarify identifier grammar 
Specifically, make it clearer that event IDs are the weird exception in this section.
 2019-06-10 14:23:04 -06:00
Travis Ralston 29340c6eb8 Clarify that the common identifier format can be broken 
We already reference in the Event IDs section that the format depends on the room version, so we just need to link there.

Fixes https://github.com/matrix-org/matrix-doc/issues/2103
 2019-06-09 22:50:23 -06:00
Travis Ralston 8ad82ce3c0 Add permalink routing through ?via parameters on matrix.to URIs 
Spec for [MSC1704](https://github.com/matrix-org/matrix-doc/pull/1704)

Reference implementations:
* Original: https://github.com/matrix-org/matrix-react-sdk/pull/2250
* Modern recommendations: 2ca281f6b7/src/matrix-to.js (L29-L70)

The only deviation from the original MSC is the recommendation for which servers to pick. The original MSC failed to consider server ACLs and IP addresses correctly, and during implementation it was realized that both of these cases should be handled. The core principles of the original MSC are left unaltered.
 2019-04-05 16:24:51 -06:00
Travis Ralston 1c5ec68cd0
Merge pull request #1876 from matrix-org/travis/v3-id-grammar 
Clarify v3 event representation in identifier grammar
 2019-03-27 08:57:11 -06:00
Travis Ralston 0ec34039e8 URL encode all the things 2019-03-20 14:44:54 -06:00
Travis Ralston 42cf72c60f URL encode matrix.to URIs 2019-03-20 14:43:16 -06:00
Hristo Venev e825224b5b Restrict identifier port numbers to 5 digits. 2019-02-21 21:27:21 +00:00
Travis Ralston 946acbf380 Clarify v3 event representation in identifier grammar 
Fixes https://github.com/matrix-org/matrix-doc/issues/1870
Fixes https://github.com/matrix-org/matrix-doc/issues/1869
Fixes https://github.com/matrix-org/matrix-doc/issues/1867
 2019-02-10 19:49:55 -07:00
Aaron Raimist fe7f582233
Fix several spelling mistakes 
Signed-off-by: Aaron Raimist <aaron@raim.ist>
 2019-02-01 16:43:46 -06:00
Travis Ralston 166d4ada86 Fix room versions reference in appendices & s2s spec 2019-01-16 17:05:57 -07:00
Travis Ralston ffe577371d 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.
 2019-01-04 15:49:24 -07:00
Konstantinos Sideris 192a6c2ab9 Use example.org on examples instead of domain.com which is a real domain 
Signed-off-by: Konstantinos Sideris <sideris.konstantin@gmail.com>
 2018-09-02 17:58:21 +03:00
Richard van der Hoff 6ba50fe2f6
Merge pull request #1588 from matrix-org/rav/fix_server_name 
Specify that server names cannot be %-encoded
 2018-08-30 10:48:06 +01:00
Richard van der Hoff 120bb8dc8e s/host/hostname/ 2018-08-29 09:24:24 +01:00
Richard van der Hoff 8679a642b4 clarity 2018-08-29 00:19:05 +01:00
Richard van der Hoff 7f9524f801 s/--/—/ 2018-08-29 00:07:36 +01:00
Richard van der Hoff 6f3b42a457 Server names cannot be %-encoded 
They aren't URLs; it was a thinko to refer to the URL spec for this.
 2018-08-28 23:56:20 +01:00
Travis Ralston 39e674ccb3 Clarify what matrix.to is and mention that room IDs are not routable 
Also actually render the warning saying that this scheme is temporary.
 2018-08-27 18:27:48 -06:00
Travis Ralston fa3e9a7609 Merge remote-tracking branch 'matrix-org/master' into travis/c2s/pills 2018-08-27 18:09:19 -06:00
Travis Ralston 312799ae78 General clarification for mention and how matrix.to URIs are meant to work 2018-08-25 22:30:49 -06:00
Travis Ralston 9835c98544 Document how mentions (pills) work 
Implements the proposal over at https://github.com/matrix-org/matrix-doc/issues/1067

Includes some specification for how matrix.to is structured, and how it is intended to be replaced.
 2018-08-21 22:05:47 -06:00
Travis Ralston fde48e7ee8 Specify how room versioning works 
This is the spec PR for https://github.com/matrix-org/matrix-doc/issues/1425

Room version upgrades are not part of MSC1425.

Documented aspects:
* room_version on the create event
* creating a room with a specific version (useful for testing)
* make_join behaviour
* error code documentation
* grammar of room versions

Based upon https://docs.google.com/document/d/1urKgReoHqxX8R_XtySB17dPi-DZcKhqTEL2_s895Wz0/edit
 2018-08-15 15:12:36 -06:00
Will Hunt bdb881420c
Merge branch 'master' into hs/dns-to-be-hostname 2018-07-24 23:12:12 +01:00
Will Hunt 26505533dd drop dns_name = host in favour of host 2018-07-24 16:06:59 +01:00
Michael Telatynski c3f66e1814
basic spec for group IDs, mostly copied from User IDs as they share grammar 2018-06-11 12:40:04 +01:00
Richard van der Hoff a36f8ba00d Forbid colons in MXIDs 
There is a single (AS) user on matrix.org who has a colon in their localpart,
but I suspect that is an artifact of old bridge code and won't work over
federation anyway.

Colons in MXIDs are particularly harmful because they make it impossible to
split mxids into local- and remote-parts
 2017-12-18 14:16:25 +00:00
Richard van der Hoff 628e723483 Move the MXID spec to the appendices 
Also link to them from the /register API doc.
 2017-10-23 00:51:40 +01:00