wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
No description
599 commits 4 branches 0 tags 17 MiB
Find a file
Kegan Dougal 1da64db302 Use relative depths for groups instead of absolute ones 
This means the group can be agnostic to how deeply nested it is,
improving reusability of groups.
2015-09-23 14:29:37 +01:00
api Make the example room id more "random" so that people are less likely to think that it is supposed to be human readable 2015-09-21 17:31:35 +01:00
attic Add v1 registration / login stuff into attic dir 2015-04-24 10:26:34 +01:00
drafts Reshuffle spec into sections roughly right as per PR #52 2015-09-21 14:13:18 +01:00
event-schemas Merge branch 'master' into markjh/document_v1_rooms_api 2015-09-21 16:35:31 +01:00
meta Update doc style 2015-02-19 17:14:25 +00:00
scripts Use relative depths for groups instead of absolute ones 2015-09-23 14:29:37 +01:00
specification Use relative depths for groups instead of absolute ones 2015-09-23 14:29:37 +01:00
supporting-docs glue footer to the bottom 2015-09-04 17:53:39 +01:00
templating Add instant_messaging module; modify batesian section rules 2015-09-23 10:48:49 +01:00
.gitignore .gitignore speculator 2015-09-14 10:33:25 +01:00
CHANGELOG.rst Add sync API yaml. Add template for sync_http_api. 2015-06-02 11:44:27 +01:00
jenkins.sh Add the jenkins command to source control so that we can update 2015-09-21 15:19:09 +01:00
README.rst alas clarify the room link 2015-06-02 16:11:27 +01: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/