matrix-spec-proposals

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

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		9 years ago
api	Flatten the response to /sync	9 years ago
attic	Add v1 registration / login stuff into attic dir	9 years ago
drafts	More formatting..	9 years ago
event-schemas	Specify guest room access	9 years ago
meta	Update doc style	9 years ago
scripts	speculator: Nessle up some more if statements	9 years ago
specification	Flatten the response to /sync	9 years ago
supporting-docs	typos and fixes	9 years ago
templating	Specify /publicRooms	9 years ago
.gitignore	.gitignore speculator	9 years ago
CHANGELOG.rst	Go into a bit more detail about feature profiles	9 years ago
README.rst	alas clarify the room link	9 years ago
jenkins.sh	If build.py throws, actually print stdout. Also run jenkins.sh in verbose mode.	9 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`` via https://matrix.org/beta.

.. _JSON Schema: http://json-schema.org/