Proposals for changes to the matrix 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 e8d11e8321 Add check.sh to automatically run z-schema over all schema files and test against examples. 9 years ago
api
attic Add v1 registration / login stuff into attic dir 10 years ago
drafts Merge pull request #9 from matrix-org/v2-presence 10 years ago
event-schemas Add check.sh to automatically run z-schema over all schema files and test against examples. 9 years ago
meta
scripts
specification typo 10 years ago
supporting-docs
templating Remove newlines from json: move line wrapping to the template files. 9 years ago
.gitignore Make the templating system work(!) 9 years ago
README.rst

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.
- ``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.

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``.