From 4b27d6a7a4d981174ec1e93a24a8b4ab4a3ade0f Mon Sep 17 00:00:00 2001 From: Jimmy Cuadra Date: Fri, 22 Apr 2016 15:43:21 -0700 Subject: [PATCH] Reorganize spec index. --- specification/index.rst | 58 ++++++++++++++++++++--------------------- 1 file changed, 28 insertions(+), 30 deletions(-) diff --git a/specification/index.rst b/specification/index.rst index 9c3897d1..8cfd3351 100644 --- a/specification/index.rst +++ b/specification/index.rst @@ -6,45 +6,43 @@ Matrix Specification .. have should hopefully not get complex enough that we need to worry about .. versioning it. -This specification has been generated from -https://github.com/matrix-org/matrix-doc using -https://github.com/matrix-org/matrix-doc/blob/master/scripts/gendoc.py as of -revision ``{{git_version}}`` - -https://github.com/matrix-org/matrix-doc/tree/{{git_rev}}. +Matrix is a set of APIs for open-federated Instant Messaging (IM), Voice +over IP (VoIP) and Internet of Things (IoT) communication, designed to create +and support a new global real-time communication ecosystem. -There is an `introduction and overview to the specification here `_. +For a more complete introduction to Matrix, see `Introduction `_. + +Matrix APIs +----------- The following APIs are documented in this specification: -- `Client-Server API `_ version %CLIENT_RELEASE_LABEL% for writing Matrix clients. -- `Server-Server API `_ version %SERVER_RELEASE_LABEL% for writing servers which can federate with Matrix. -- `Application Service API `_ version %CLIENT_RELEASE_LABEL% for writing privileged plugins to servers. -- `Identity Service API `_ version unstable for mapping third party identifiers (e.g. email addresses) to Matrix IDs. -- `Push Gateway API `_ version unstable for implementing a server that receives notifications about Matrix events a user is interested in. +- `Client-Server API `_ (%CLIENT_RELEASE_LABEL%) Interaction between clients and servers +- `Server-Server API `_ (%SERVER_RELEASE_LABEL%) Federation between servers +- `Application Service API `_ (%CLIENT_RELEASE_LABEL%) Privileged server plugins +- `Identity Service API `_ (unstable) Mapping of third party IDs with Matrix IDs +- `Push Gateway API `_ (unstable) Push notifications for Matrix events -There are also some `appendices `_. +`Appendices `_ with supplemental information not specific to +of the above APIs is also available. -Any developments since the latest release can be found `here`__. +Specification Version +--------------------- -.. __: https://matrix.org/speculator/spec/head/ +The documents in the specification are generated from +`matrix-doc `_ as of Git commit +`{{git_version}} `_. -Old releases of the spec: +The following other versions of the specification are also available, +in reverse chronological order: +- `HEAD `_: Includes all changes since the latest versioned release. - `r0.0.1 `_ - `r0.0.0 `_ +- `Legacy `_: The last draft before the spec was formally released in version r0.0.0. -Before we formally started releasing the specification, the last working copy -we had can be found `here`__. - -.. __: https://matrix.org/docs/spec/legacy/ - -Versioning ----------- - -The specifications are each versioned in the form ``rX.Y.Z``. - -Changes to ``X`` and ``Y`` should not be assumed to be compatible with any other version. - -For a fixed ``X`` and ``Y``, any ``Z`` should be assumed to be compatible with any lesser ``Z``. - -For example, it is safe to assume that a server which claims to implement ``r0.1.2`` supports ``r0.1.0``, but not vice-versa. +The specification for each API is versioned in the form ``rX.Y.Z``. Changes to +``X`` and ``Y`` should not be assumed to be compatible with any other version. +For a fixed ``X`` and ``Y``, any ``Z`` should be assumed to be compatible with +any lesser ``Z``. For example, it is safe to assume that a server which claims +to implement ``r0.1.2`` supports ``r0.1.0``, but not vice-versa.