matrix-spec

The Matrix protocol 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

David Baker 199bb87ffa Add link to v1 docs.		10 years ago
api	Test swagger commit	10 years ago
attic	Add v1 registration / login stuff into attic dir	10 years ago
drafts	lots of fixes based on kegan's review of https://github.com/matrix-org/matrix-doc/pull/13	10 years ago
meta	…
scripts	lots of fixes based on kegan's review of https://github.com/matrix-org/matrix-doc/pull/13	10 years ago
specification	Add link to v1 docs.	10 years ago
supporting-docs	Add IRC bridge AS example.	10 years ago
.gitignore	…
README.rst	Actually add the README	10 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``.