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)
1,257 Commits 670 Branches 26 Tags 28 MiB
Markdown 100%
Go to file
Mark Haines c3a1318886 Make it explicit that the JSON filter object is passed as a string 2015-12-09 10:50:02 +00:00
api Make it explicit that the JSON filter object is passed as a string 2015-12-09 10:50:02 +00:00
attic Consistently spell homeserver as homeserver 2015-12-02 19:23:33 +00:00
changelogs Flesh out changelog 2015-12-07 15:19:54 +00:00
drafts Remove e2e drafts from master 2015-12-07 14:45:46 +00:00
event-schemas Make all the schema files yaml 2015-12-07 13:56:36 +00:00
meta Update doc style 2015-02-19 17:14:25 +00:00
scripts Remove accidentally committed change 2015-12-07 15:16:06 +00:00
specification Decide that joining HS is the one that specifies the join event ID 2015-12-08 14:04:40 +00:00
supporting-docs Consistently spell homeserver as homeserver 2015-12-02 19:23:33 +00:00
templating Changelogs: indent instead of blockquoting 2015-12-08 11:43:10 +00:00
.gitignore .gitignore speculator 2015-09-14 10:33:25 +01:00
README.rst alas clarify the room link 2015-06-02 16:11:27 +01:00
jenkins.sh Remove redundant node event schema checker 2015-11-30 16:40:48 +00: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/