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)
524 Commits 669 Branches 26 Tags 28 MiB
Markdown 100%
Go to file
Mark Haines 7b7d124f24 Merge remote-tracking branch 'origin/master' into client_server_v2_http_api 2015-09-11 16:37:16 +01:00
api Merge pull request #40 from matrix-org/markjh/history_for_rooms_that_have_been_left 2015-09-11 12:55:07 +01:00
attic Add v1 registration / login stuff into attic dir 2015-04-24 10:26:34 +01:00
drafts Merge branch 'master' into client_server_v2_http_api 2015-09-11 10:50:29 +01:00
event-schemas Merge pull request #27 from matrix-org/receipts 2015-09-10 16:18:19 +01:00
meta Update doc style 2015-02-19 17:14:25 +00:00
scripts Merge pull request #44 from matrix-org/speculator-errs 2015-09-11 15:30:15 +01:00
specification Merge pull request #36 from matrix-org/daniel/threepidinvites 2015-09-11 11:59:21 +01:00
supporting-docs glue footer to the bottom 2015-09-04 17:53:39 +01:00
templating Merge pull request #27 from matrix-org/receipts 2015-09-10 16:18:19 +01:00
.gitignore continuserv: Live serves updates to the spec 2015-09-10 11:16:31 +01:00
CHANGELOG.rst Add sync API yaml. Add template for sync_http_api. 2015-06-02 11:44:27 +01:00
README.rst alas clarify the room link 2015-06-02 16:11:27 +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/