No description
Find a file
Matthew Hodgson 598e9b3113 big reshuffle:
* try to make 00_basis slightly more accessible and less terse
 * move CS API before Events, as it's meaningless to dive into specific events if you haven't been introduced to how the CS API works
 * Try to improve the beginning of the CS API by merging back in some of kegan's original v1 content (which has subsequently been deleted somewhere along the line?)
 * document m.presence event consistently
 * move typing from drafts to spec
 * move push stuff from drafts to spec
...and lots of other stuff

move push & typing from drafts into main spec.
2015-03-16 00:14:03 -04:00
api Test swagger commit 2015-02-20 14:29:51 +00:00
drafts big reshuffle: 2015-03-16 00:14:03 -04:00
meta Update doc style 2015-02-19 17:14:25 +00:00
scripts big reshuffle: 2015-03-16 00:14:03 -04:00
specification big reshuffle: 2015-03-16 00:14:03 -04:00
supporting-docs Add IRC bridge AS example. 2015-02-20 15:06:43 +00:00
.gitignore Redo gendoc script. 2015-02-19 16:00:21 +00:00
README.rst Actually add the README 2015-02-20 10:43:54 +00:00

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