matrix
/
matrix-doc
mirror of https://github.com/matrix-org/matrix-doc.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Matrix Documentation (including The Spec)
971 Commits 670 Branches 26 Tags 28 MiB
Markdown 100%
Go to file
Mark Haines 3f1cbb22bb Enable syntax highlighting for the JSON event examples 2015-10-26 16:27:57 +00:00
api Merge pull request #129 from matrix-org/erikj/search_actual 2015-10-26 10:20:56 +00:00
attic Add v1 registration / login stuff into attic dir 2015-04-24 10:26:34 +01:00
drafts Merge pull request #26 from matrix-org/macaroons 2015-09-25 13:18:27 +01:00
event-schemas Allow history to be noted as world-readable 2015-10-23 14:02:53 +01:00
meta Update doc style 2015-02-19 17:14:25 +00:00
scripts Cache spec output 2015-10-26 10:28:14 +00:00
specification Rename section 2015-10-26 14:14:13 +00:00
supporting-docs typos and fixes 2015-10-09 17:43:46 +01:00
templating Enable syntax highlighting for the JSON event examples 2015-10-26 16:27:57 +00:00
.gitignore .gitignore speculator 2015-09-14 10:33:25 +01:00
CHANGELOG.rst Go into a bit more detail about feature profiles 2015-10-02 16:34:06 +01:00
README.rst alas clarify the room link 2015-06-02 16:11:27 +01:00
jenkins.sh If build.py throws, actually print stdout. Also run jenkins.sh in verbose mode. 2015-10-07 10:34:29 +01:00

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/