matrix-spec

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.

Go to file

Kegan Dougal 1f6b12b3e8 Modify and enforce the file format/structure used Convert the file format to be of the form ##_##_something.rst where the first ## is the top-level section number and the second ## is the second-level section number, e.g. 07_01_push_cs_api.rst means Section 7.1 - This is now enforced in gendoc.py along with the title line style that should be used (= for top-level, - for 2nd level) which will give helpful suggestions if you trip up. This feels much more intuitive now looking in /specification		10 years ago
api	replace definitions/*event.yaml with symlinks to /event-schemas/	10 years ago
attic	Add v1 registration / login stuff into attic dir	11 years ago
drafts	Merge pull request #9 from matrix-org/v2-presence	11 years ago
event-schemas	Remove accidentally committed swp file	10 years ago
meta	Update doc style	11 years ago
scripts	Modify and enforce the file format/structure used	10 years ago
specification	Modify and enforce the file format/structure used	10 years ago
supporting-docs	glue footer to the bottom	10 years ago
templating	Minor formatting fixes. Fix state event templating.	10 years ago
.gitignore	.gitignore speculator	10 years ago
CHANGELOG.rst	Add sync API yaml. Add template for sync_http_api.	11 years ago
README.rst	alas clarify the room link	11 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/