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
Mark Haines 91eb25b76d Include the full schema for an http API in the docs by resolving references to other files 9 years ago
api typo 9 years ago
attic Add v1 registration / login stuff into attic dir 9 years ago
drafts Merge pull request #26 from matrix-org/macaroons 9 years ago
event-schemas Allow history to be noted as world-readable 9 years ago
meta Update doc style 10 years ago
scripts Enable syntax highlighting for example http requests 9 years ago
specification Use 'room' or 'room ID' instead of 'context' when describing federation protocol 9 years ago
supporting-docs typos and fixes 9 years ago
templating Include the full schema for an http API in the docs by resolving references to other files 9 years ago
.gitignore .gitignore speculator 9 years ago
CHANGELOG.rst Go into a bit more detail about feature profiles 9 years ago
README.rst alas clarify the room link 9 years ago
jenkins.sh If build.py throws, actually print stdout. Also run jenkins.sh in verbose mode. 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/