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
Kegan Dougal 9d7f2baf5c Mention that knock/private on join_rules are not implemented. 10 years ago
api Test swagger commit 10 years ago
attic Add v1 registration / login stuff into attic dir 10 years ago
drafts Merge pull request #9 from matrix-org/v2-presence 10 years ago
event-schemas Mention that knock/private on join_rules are not implemented. 10 years ago
meta Update doc style 10 years ago
scripts Sort out table layout and rejig where state_key is placed. 10 years ago
specification Template up common event fields from the 'core' json schema file. 10 years ago
supporting-docs Add IRC bridge AS example. 10 years ago
templating Sort keys alphabetically in tables. Sort event types alphabetically in sections. 10 years ago
.gitignore Update .gitignore 10 years ago
README.rst Add new folders to 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.
- ``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``.

.. _JSON Schema: http://json-schema.org/