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,683 Commits 670 Branches 26 Tags 28 MiB
Markdown 100%
Go to file
David Baker d66ea3c3ce Don't line wrap the API descriptions 
They are in RST format which is whitespace sensitive and threfore can't be line wrapped without breaking the syntax.

There is more wrapping in other places but some of it is into tables where it does need to be fixed width in order for the RST table to parse correctly.
 		2016-07-08 11:57:40 +01:00
api Merge pull request #345 from Ralith/require-prev_batch 2016-07-07 21:08:56 +01:00
attic Consistently spell homeserver as homeserver 2015-12-02 19:23:33 +00:00
changelogs m.room.power_levels: clarify documentation 2016-06-22 17:45:49 +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 #342 from matrix-org/erikj/presence 2016-06-29 11:36:55 +01:00
meta Update doc style 2015-02-19 17:14:25 +00:00
scripts Add PyYAML to scripts/README.md 2016-06-11 14:10:21 +03:00
specification Merge pull request #343 from matrix-org/dbkr/threepid_requesttoken 2016-07-05 15:17:18 +01:00
supporting-docs adding link to spreadsheet in synapse project page 2016-06-30 17:20:57 +01:00
templating Don't line wrap the API descriptions 2016-07-08 11:57:40 +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
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/