archive
/
matrix-spec
mirror of https://github.com/matrix-org/matrix-spec
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
The Matrix protocol specification
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
1,394 Commits
23 Branches
37 Tags
18 MiB
HTML 47.1%
Python 19.8%
CSS 13.1%
SCSS 11.4%
JavaScript 6.5%
Other 2%
 
 
 
 
 
 
main
dbkr/msc4178
release/v1.12
release/v1.11
tulir/msc4142
release/v1.10
travis/msc2702-msc2701
rav/ref_objects_in_params
dkasak/foldable-sidebar
travis/knock-join
release/v1.9
release/v1.8
anoa/update_docsy
anoa/nix_flake
dbkr/3077-multi-stream-voip
release/v1.7
dbkr/2746-reliable-voip
rav/links_for_object_defs
release/v1.6
release/v1.5
release/v1.4
anoa/invite_knock_room_state
release/v1.3
push_gateway/r0.1.0
r0.0.0
0.2.0
application_service/r0.1.0
application_service/r0.1.1
application_service/r0.1.2
client-server/0.3.0
client-server/r0.1.0
client-server/r0.2.0
client-server/r0.3.0
client_server/r0.4.0
client_server/r0.5.0
client_server/r0.6.0
client_server/r0.6.1
identity_service/r0.1.0
identity_service/r0.2.0
identity_service/r0.2.1
identity_service/r0.3.0
push_gateway/r0.1.1
r0.0.1
server_server/r0.1.0
server_server/r0.1.1
server_server/r0.1.2
server_server/r0.1.3
server_server/r0.1.4
v1.1
v1.10
v1.11
v1.12
v1.2
v1.3
v1.4
v1.5
v1.6
v1.7
v1.8
v1.9
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '5cf22c210e'
${ noResults }
Go to file
Daniel Wagner-Hall 5cf22c210e Merge pull request #261 from matrix-org/daniel/join 
/join and /room/:roomId/join aren't exact aliases

Separate them, clarify their differences.

Also, fix some links which weren't being properly populated.
 		9 years ago
api /join and /room/:roomId/join aren't exact aliases 9 years ago
attic Consistently spell homeserver as homeserver 9 years ago
changelogs Start development on next spec version 9 years ago
drafts Delete old drafts 9 years ago
event-schemas Explain what the room member states mean 9 years ago
meta Update doc style 10 years ago
scripts Speed up gendoc.py by only running build.py once 9 years ago
specification /join and /room/:roomId/join aren't exact aliases 9 years ago
supporting-docs EOL mailman 9 years ago
templating /join and /room/:roomId/join aren't exact aliases 9 years ago
.gitignore .gitignore speculator 9 years ago
README.rst alas clarify the room link 10 years ago
jenkins.sh Remove redundant node event schema checker 9 years ago

README.rst 

This repository contains the documentation for Matrix.

Structure
=========

- ``api`` : Contains the HTTP API specification.
- ``drafts`` : Contains documents which will make it into the specification
  and/or supporting documentation at some point in the future.
- ``event-schemas`` : Contains the `JSON Schema`_ for all Matrix events
  contained in the specification, along with example JSON files.
- ``meta`` : Contains documents outlining the processes involved when writing
  documents, e.g. documentation style, guidelines.
- ``scripts`` : Contains scripts to generate formatted versions of the
  documentation, typically HTML.
- ``specification`` : Contains the specification split up into sections.
- ``supporting-docs`` : Contains additional documents which explain design 
  decisions, examples, use cases, etc.
- ``templating`` : Contains the templates and templating system used to
  generate the spec.

Contributing
============

Known issues with the specification are represented as JIRA issues at
https://matrix.org/jira/browse/SPEC

If you want to ask more about the specification, or have suggestions for
improvements, join us on ``#matrix-dev:matrix.org`` via https://matrix.org/beta.

.. _JSON Schema: http://json-schema.org/