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
Richard van der Hoff 6265d6ce06 Merge pull request #254 from matrix-org/rav/filter_spec
Add some missing titles to the filter upload spec
9 years ago
api Merge pull request #254 from matrix-org/rav/filter_spec 9 years ago
attic Consistently spell homeserver as homeserver 9 years ago
changelogs Add a changelog for r0.0.1 9 years ago
drafts Delete old drafts 9 years ago
event-schemas Explain what the room member states mean 9 years ago
meta Update doc style 10 years ago
scripts Detect major version in presence of patch release 9 years ago
specification Merge pull request #251 from matrix-org/daniel/guestshiz 9 years ago
supporting-docs EOL mailman 9 years ago
templating Don't sort the properties in object schemas 9 years ago
.gitignore .gitignore speculator 9 years ago
README.rst alas clarify the room link 10 years ago
jenkins.sh Remove redundant node event schema checker 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/