wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
No description
371 commits 4 branches 0 tags 17 MiB
Find a file
Kegan Dougal 96671ce833 Use the templating system to set {{git_version}}. Restructure sections code. 
Restructured the sections code to be slightly more encapsulated than before.
This will be expanded to more clearly separate the templating system from
the specific implementation of the spec templates.
2015-05-26 14:33:32 +01:00
api Test swagger commit 2015-02-20 14:29:51 +00: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 Mention that knock/private on join_rules are not implemented. 2015-05-26 11:21:20 +01:00
meta Update doc style 2015-02-19 17:14:25 +00:00
scripts Use the templating system to set {{git_version}}. Restructure sections code. 2015-05-26 14:33:32 +01:00
specification Use the templating system to set {{git_version}}. Restructure sections code. 2015-05-26 14:33:32 +01:00
supporting-docs Use the templating system to set {{git_version}}. Restructure sections code. 2015-05-26 14:33:32 +01:00
templating Use the templating system to set {{git_version}}. Restructure sections code. 2015-05-26 14:33:32 +01:00
.gitignore Update .gitignore 2015-05-26 11:00:40 +01:00
README.rst Add new folders to README 2015-05-20 17:48:17 +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``.

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