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
Daniel Wagner-Hall 2f3a00fe34 Consistently spell homeserver as homeserver 10 years ago
api Consistently spell homeserver as homeserver 10 years ago
attic Consistently spell homeserver as homeserver 10 years ago
drafts Consistently spell homeserver as homeserver 10 years ago
event-schemas Unify v1 and v2 event schemas 10 years ago
meta Update doc style 11 years ago
scripts Consistently spell homeserver as homeserver 10 years ago
specification Consistently spell homeserver as homeserver 10 years ago
supporting-docs Consistently spell homeserver as homeserver 10 years ago
templating Embed client and server release numbers 10 years ago
.gitignore .gitignore speculator 10 years ago
CHANGELOG.rst Revert "Changelog for 0.3.0" 10 years ago
README.rst alas clarify the room link 11 years ago
jenkins.sh Remove redundant node event schema checker 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`` via https://matrix.org/beta.

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