No description
Find a file
Richard van der Hoff 01f8173c84 Put each bit of spec in its own directory
I want to change the URLs for the spec sections on the website from
<version>/<section>.html to <section>/<version>.html, to better reflect how we
do the versioning.

This puts each bit of spec in its own directory, updates the index to point to
the right place, and fixes continuserv to deal with directories as well as
files.

This will probably require fixes to the speculator too, but I'll have to come
back to that.
2016-05-05 18:26:17 +01:00
api Fix the swagger for /search so that it works without preprocessing 2016-05-04 14:55:43 +01:00
attic Consistently spell homeserver as homeserver 2015-12-02 19:23:33 +00:00
changelogs C-S API will be released as r1.0.0, not r0.1.0 2016-05-05 15:34:52 +01:00
drafts random incoherent thoughts on reputation that should live somewhere 2016-02-09 12:07:58 +00:00
event-schemas Merge pull request #321 from matrix-org/rav/fix_eventschema_readme 2016-05-05 11:41:38 +01:00
meta Update doc style 2015-02-19 17:14:25 +00:00
scripts Put each bit of spec in its own directory 2016-05-05 18:26:17 +01:00
specification Put each bit of spec in its own directory 2016-05-05 18:26:17 +01:00
supporting-docs Remove port number from room IDs in pasted examples 2016-04-25 13:55:57 +01:00
templating Put each bit of spec in its own directory 2016-05-05 18:26:17 +01:00
.gitignore Dump-swagger: take output file name rather than output dir 2016-05-03 12:03:21 +01:00
CONTRIBUTING.rst Add CONTINUTING.rst 2016-03-04 16:08:46 +00:00
jenkins.sh Remove redundant node event schema checker 2015-11-30 16:40:48 +00:00
README.rst alas clarify the room link 2015-06-02 16:11:27 +01:00

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/