Commit Graph

60 Commits (7236f1c7414f58bf2fc89e366463397c20b7406a)

Author SHA1 Message Date
Charlie Varley 4d835c1753
Update index.rst 5 years ago
Travis Ralston f44483a8cf
Merge pull request #2099 from matrix-org/travis/1.0/1.0-notice
Declare Matrix 1.0 in the index
5 years ago
Travis Ralston 2d18f81807
Merge pull request #2087 from matrix-org/travis/1.0/events-are-extensible
Reorganize event structure in c2s spec and clarify event capabilities
5 years ago
Travis Ralston 6d60258e25
Merge pull request #2080 from matrix-org/travis/1.0/msc2076-msc2077-v5-rooms
Spec v5 rooms: Key validity
5 years ago
Travis Ralston b7378a860a
Merge pull request #2097 from matrix-org/travis/1.0/common-themes
Specify some of the common concepts for Matrix in the index
5 years ago
Travis Ralston 51698a5dd5 Clarify that people must own the namespace to use it 5 years ago
Travis Ralston 19c827e581 Remove trailing slashes section 5 years ago
Travis Ralston 49831fb74f Clarifications about namespaces 5 years ago
Travis Ralston 4f665f06e6 Clarify what Matrix 1.0 is further
And add a table for minimum versions.
5 years ago
Travis Ralston 49dbb3ee4f Declare Matrix 1.0 in the index
Fixes https://github.com/matrix-org/matrix-doc/issues/2044
5 years ago
Travis Ralston b9c9396c11 Specify some of the common concepts for Matrix in the index
See https://github.com/matrix-org/matrix-doc/pull/2061
Fixes https://github.com/matrix-org/matrix-doc/issues/1468
Fixes https://github.com/matrix-org/matrix-doc/issues/1528

The section is not referenced by the specifications yet - they do a fairly good job of explaining it over and over. In future, it would be good to point all the references to the index.
5 years ago
Travis Ralston 8fd5b15594 Reorganize event structure in c2s spec and clarify event capabilities
Fixes https://github.com/matrix-org/matrix-doc/issues/1166
Fixes https://github.com/matrix-org/matrix-doc/issues/1527
Fixes https://github.com/matrix-org/matrix-doc/issues/1827

Note: In order to fix the "state events have the following fields: [no words]" bug (1827) we need to resolve references on common event types. When doing this we ultimately end up with more fields than may be required to explain the section, however this commit alters the section descriptions to just say "these fields" instead of "these additional fields".

This is also preferable over trying to get the inheritance reversed in the common event types, as the `/sync` endpoint has a high amount of reliance on partial events definitions.
6 years ago
Travis Ralston 80aa5a24dc Make v4 the "default" room version
As per [MSC2002](https://github.com/matrix-org/matrix-doc/pull/2002). This was missed in https://github.com/matrix-org/matrix-doc/pull/2019

Fixes https://github.com/matrix-org/matrix-doc/issues/2071
6 years ago
Travis Ralston a6314df44c Spec v5 rooms: Key validity
Proposals:
* [MSC2076](https://github.com/matrix-org/matrix-doc/pull/2076)
* [MSC2077](https://github.com/matrix-org/matrix-doc/pull/2077)

Implementation references:
* 00bf99fa62
* https://github.com/matrix-org/synapse/pull/5354
* https://github.com/matrix-org/synapse/pull/5321

No known differences from the proposals are included here - alterations are accidental.
6 years ago
Travis Ralston 3b0e194ff7 Add version 4 rooms to the spec
As per [MSC1884](https://github.com/matrix-org/matrix-doc/pull/1884) and [MSC2002](https://github.com/matrix-org/matrix-doc/pull/2002).

No known changes since the proposals were accepted.

Due to being in the area: This fixes https://github.com/matrix-org/matrix-doc/issues/1863
6 years ago
Ben Parsons 99405418c9 in the appendices, thanks earfolds 6 years ago
Travis Ralston 1f5783b329 fix links and wording 6 years ago
Travis Ralston 9631e4bcb1 Add a bit of text to ensure that the intro page isn't missed 6 years ago
Aaron Raimist fe7f582233
Fix several spelling mistakes
Signed-off-by: Aaron Raimist <aaron@raim.ist>
6 years ago
Travis Ralston 01556e5b17 Clarifications and bug fixes in how v3 rooms work 6 years ago
Travis Ralston ff75996524 Add specification for room version 3: Event IDs as hashes
Original proposal: https://github.com/matrix-org/matrix-doc/pull/1659
Implementation proofs (some traversing of the PR tree may be required to get all of them):
* https://github.com/matrix-org/synapse/pull/4483
* https://github.com/matrix-org/synapse/pull/4499

This doesn't intentionally change anything from the proposal.

**Implementation details**:

The simple part of this is the introduction of a rooms/v3.html document. The somewhat unclear part is the stuff done to the s2s definitions. This pulls `unsigned_pdu` out to `unsigned_pdu_base` (all fields except `event_id`) where it can be reused in `pdu` and `pdu_v3` (for rooms v3). These definitions are further moved into the room version specifications where they can highlight the exact schemas in detail.

Version 1 has been updated to include the pre-existing event format, however the core principles of the room have not been changed. The same applies to room version 2. Room versions have immutable core principles once in the spec, otherwise these format changes would land in a pre-existing version.

The client-server API event formats will need updating, however that is being punted to a different commit to try and keep these changes reviewable.
6 years ago
Richard van der Hoff 9f443225ac fix incorrect spelling of homeserver 6 years ago
Travis Ralston 061f59547a Minor wording changes 6 years ago
Travis Ralston bd5e760a0d Simplify the description for room versions
Instead of trying to describe maturity, stability, and recommendedness in one list we should describe what is "safe" and "unsafe" to use. The default version is just something that servers should use, and is normally going to be stable.
6 years ago
Hubert Chathi ebe887d931
Grammar
Co-Authored-By: turt2live <travpc@gmail.com>
6 years ago
Travis Ralston ba37f2d311 prompt->advertise 6 years ago
Travis Ralston 19e94815f9 Try and improve the understanding of room versions 6 years ago
Travis Ralston 0dde2489b6 Clarify what a Mandatory room version is 6 years ago
Travis Ralston 96d754f429 promote -> prompt 6 years ago
Travis Ralston a6f5d01586 Clarify that servers don't have to implement development/beta versions 6 years ago
Travis Ralston 71e6321f4d Rework how room versions are represented
Versions are actually on a scale of recommendations, and are expected to be created as needed. The scale presented here (develop/beta/default/recommended/mandatory) is a more wordy version of what was previously discussed/intended for room versions - the labels aren't final and may be changed.
6 years ago
Ben Parsons 16f17855c9 link to CS API Swagger Viewer 6 years ago
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>
6 years ago
Travis Ralston 7ac76fa27c Actually we're going with "identity server" afterall 6 years ago
Travis Ralston ec248b436f Identity Service is lowercase 6 years ago
Travis Ralston cc0badaaa1 Fix all naming cases of "identity service"
Fixes https://github.com/matrix-org/matrix-doc/issues/1396

Includes some "homeserver" fixes too. This commit does not include historical documentation or notes.
6 years ago
Ben Parsons e7c79f2bd4 avoid .rst link conflict warnings 6 years ago
Ben Parsons 54d6d58fff naively move content from intro.rst to index.rst 6 years ago
Ben Parsons 8d550d2166 force re-render 7 years ago
Ben Parsons 0b776b0e9c link to proposals page from index 7 years ago
Richard van der Hoff c08e6616c7 Try to make the intro link more obvious
Fixes https://github.com/matrix-org/matrix-doc/issues/1031.
7 years ago
Richard van der Hoff 49cd65dd58 Add a license to the spec
We're licensing hte spec under ASLv2. Add the LICENSE file, and add the
short-form to as much of the source as is practical right now (adding it to
json source is a massive pita).
8 years ago
Richard van der Hoff 351bbee016 Remove changelog from index.rst
... since it's explicitly unversioned.
9 years ago
Richard van der Hoff 5b010de2b3 Fix typo 9 years ago
Richard van der Hoff e68193d2e0 Attempt to clarify the spec versioning. Again. 9 years ago
Matthew Hodgson 17b8fccd4c rephrase intro 9 years ago
Jimmy Cuadra c44d61b3a9 Clarify which documents are generated from scripts. 9 years ago
Jimmy Cuadra 22b542e3f9 Fix grammar in spec index. 9 years ago
Jimmy Cuadra 5b18db9096 Make list of APIs on the index a table. 9 years ago
Jimmy Cuadra 4b27d6a7a4 Reorganize spec index. 9 years ago