mirror of
https://github.com/matrix-org/matrix-spec
synced 2026-01-02 05:58:37 +01:00
db25276856
This is going to be painful to represent due to how the push API allows
mixed types (strings or objects) and mixed top-level keys ("content" rule kind
allowing "pattern" as a top-level key). We may wish to re-visit the design
of this API for v2.
|
||
|---|---|---|
| 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/