No description
Find a file
Richard van der Hoff 29bd4d45ee Flatten the response to /sync
Now that we don't expect there to be duplication betwen the 'timeline' and
'state' results, there's no point in having the state map. (That does mean the
events themselves need event_id fields though).

Also:

- move the contents of the 'unsigned' dictionary into the events themselves
- replace the state list with two layers of dictionary keyed on type and
  state_key
- rename the children of the 'rooms' dict from "joined/invited/archived" to
  "join/invite/leave" to match the membership states
2015-11-16 00:00:48 +00:00
api Flatten the response to /sync 2015-11-16 00:00:48 +00:00
attic Add v1 registration / login stuff into attic dir 2015-04-24 10:26:34 +01:00
drafts More formatting.. 2015-11-10 11:31:31 +00:00
event-schemas Specify guest room access 2015-11-06 18:15:21 +00:00
meta Update doc style 2015-02-19 17:14:25 +00:00
scripts speculator: Nessle up some more if statements 2015-11-11 15:13:34 +00:00
specification Flatten the response to /sync 2015-11-16 00:00:48 +00:00
supporting-docs typos and fixes 2015-10-09 17:43:46 +01:00
templating Specify /publicRooms 2015-11-11 11:39:40 +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
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 alas clarify the room link 2015-06-02 16:11:27 +01:00

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/