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)
561 Commits 673 Branches 26 Tags 32 MiB
Markdown 100%
Go to file
Mark Haines 2c31731262 Add the jenkins command to source control so that we can update 
it without having to fiddle with the jenkins UI.

It also allow us to move files without breaking the CI since we
won't be hard coding the locations of scripts in the jenkins UI.
 		2015-09-21 15:19:09 +01:00
api Make to code to skip checking swagger responses which don't have an 2015-09-18 16:35:27 +01:00
attic Add v1 registration / login stuff into attic dir 2015-04-24 10:26:34 +01:00
drafts Merge pull request #9 from matrix-org/v2-presence 2015-05-18 14:02:09 +01:00
event-schemas Skip files that start with ".", e.g. vim swp files. 2015-09-21 15:05:10 +01:00
meta Update doc style 2015-02-19 17:14:25 +00:00
scripts Merge pull request #51 from matrix-org/daniel/gendoc 2015-09-18 15:50:56 +01:00
specification Modify and enforce the file format/structure used 2015-09-18 11:43:53 +01:00
supporting-docs glue footer to the bottom 2015-09-04 17:53:39 +01:00
templating Merge remote-tracking branch 'origin/master' into markjh/swagger_examples 2015-09-18 16:11:26 +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
README.rst alas clarify the room link 2015-06-02 16:11: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 

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/