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
Paul Evans eb61f018c2 Merge pull request #144 from matrix-org/paul/small-fixes
Don't mark 'aliases' on m.room.canonical_alias as required
9 years ago
api Swaggerify /ban 9 years ago
attic Add v1 registration / login stuff into attic dir 10 years ago
drafts Fix up the multi-hash ratchet thing 9 years ago
event-schemas Merge pull request #144 from matrix-org/paul/small-fixes 9 years ago
meta Update doc style 10 years ago
scripts Generate API docs from swagger 9 years ago
specification Swaggerify /ban 9 years ago
supporting-docs typos and fixes 9 years ago
templating Merge pull request #163 from matrix-org/rav/rework_objects 9 years ago
.gitignore .gitignore speculator 9 years ago
CHANGELOG.rst Revert "Changelog for 0.3.0" 9 years ago
README.rst alas clarify the room link 10 years ago
jenkins.sh Always try to build continuserv & speculator on 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/