No description
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 |
||
---|---|---|
api | ||
attic | ||
drafts | ||
event-schemas | ||
meta | ||
scripts | ||
specification | ||
supporting-docs | ||
templating | ||
.gitignore | ||
CHANGELOG.rst | ||
jenkins.sh | ||
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/