matrix-doc

Matrix Documentation (including The Spec)

Go to file

Kegan Dougal 9fd57c6fe6 Namespace all the things to v1.		2015-05-19 15:28:08 +01:00
api	Test swagger commit	2015-02-20 14:29:51 +00:00
attic	Add v1 registration / login stuff into attic dir	2015-04-24 10:26:34 +01:00
drafts	Merge pull request #9 from matrix-org/v2-presence	2015-05-18 14:02:09 +01:00
event-schemas	Namespace all the things to v1.	2015-05-19 15:28:08 +01:00
meta	Update doc style	2015-02-19 17:14:25 +00:00
scripts	lots of fixes based on kegan's review of https://github.com/matrix-org/matrix-doc/pull/13	2015-03-19 14:20:58 +01:00
specification	typo	2015-05-09 14:53:48 +01: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

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