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 a73cc50aa9 s|client/api/v2_alpha|client/v2_alpha| 9 years ago
api s|client/api/v2_alpha|client/v2_alpha| 9 years ago
attic Add v1 registration / login stuff into attic dir 10 years ago
drafts Reshuffle spec into sections roughly right as per PR #52 9 years ago
event-schemas Merge branch 'master' into markjh/document_v1_rooms_api 9 years ago
meta Update doc style 10 years ago
scripts Add more logging and make logging context clearer 9 years ago
specification Use relative depths for groups instead of absolute ones 9 years ago
supporting-docs glue footer to the bottom 9 years ago
templating Add more logging and make logging context clearer 9 years ago
.gitignore .gitignore speculator 9 years ago
CHANGELOG.rst Add sync API yaml. Add template for sync_http_api. 10 years ago
README.rst alas clarify the room link 10 years ago
jenkins.sh Check "v2_alpha" in jenkins 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/