Actually add the README
parent
c4056bec1b
commit
31ec39db7f
@ -0,0 +1,24 @@
|
|||||||
|
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.
|
||||||
|
- ``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.
|
||||||
|
|
||||||
|
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``.
|
||||||
Loading…
Reference in New Issue