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
Matthew Hodgson c3f29ea720 Merge branch 'master' into ua925_reshuffle 9 years ago
api Test swagger commit 9 years ago
drafts lots of fixes based on kegan's review of https://github.com/matrix-org/matrix-doc/pull/13 9 years ago
meta Update doc style 9 years ago
scripts lots of fixes based on kegan's review of https://github.com/matrix-org/matrix-doc/pull/13 9 years ago
specification Merge branch 'master' into ua925_reshuffle 9 years ago
supporting-docs Add IRC bridge AS example. 9 years ago
.gitignore Redo gendoc script. 9 years ago
README.rst Actually add the README 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.
- ``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``.