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 bb9537b824 Add a CHANGELOG. Modify table CSS.
Hook up templating system to read the CHANGELOG for version and changelog info.
Modified nature.css to make it clearer on table headings/sub-headings. Use the
full _matrix/client path on title links to make it clear it is for v1.
11 years ago
api Add sortFn for profile HTTP API. Add combined profile HTTP API. 11 years ago
attic Add v1 registration / login stuff into attic dir 11 years ago
drafts Merge pull request #9 from matrix-org/v2-presence 11 years ago
event-schemas Fix sort order for VoIP events. 11 years ago
meta Update doc style 11 years ago
scripts Add a CHANGELOG. Modify table CSS. 11 years ago
specification Add a CHANGELOG. Modify table CSS. 11 years ago
supporting-docs Fix RST 11 years ago
templating Add a CHANGELOG. Modify table CSS. 11 years ago
.gitignore Update .gitignore 11 years ago
CHANGELOG.rst Add a CHANGELOG. Modify table CSS. 11 years ago
README.rst Add new folders to README 11 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/