Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2026-03-10 21:44:11 +01:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Add new folders to README

Browse source
This commit is contained in:
Kegsay 2015-05-20 17:48:17 +01:00
parent bfb6d920d2
commit 717ad190ab
1 changed files with 6 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
README.rst
View file

@ -6,6 +6,8 @@ Structure
- ``api`` : Contains the HTTP API specification. - ``api`` : Contains the HTTP API specification.
- ``drafts`` : Contains documents which will make it into the specification - ``drafts`` : Contains documents which will make it into the specification
and/or supporting documentation at some point in the future. 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 - ``meta`` : Contains documents outlining the processes involved when writing
documents, e.g. documentation style, guidelines. documents, e.g. documentation style, guidelines.
- ``scripts`` : Contains scripts to generate formatted versions of the - ``scripts`` : Contains scripts to generate formatted versions of the
@ -13,6 +15,8 @@ Structure
- ``specification`` : Contains the specification split up into sections. - ``specification`` : Contains the specification split up into sections.
- ``supporting-docs`` : Contains additional documents which explain design - ``supporting-docs`` : Contains additional documents which explain design
decisions, examples, use cases, etc. decisions, examples, use cases, etc.
- ``templating`` : Contains the templates and templating system used to
generate the spec.
Contributing Contributing
============ ============
@ -22,3 +26,5 @@ https://matrix.org/jira/browse/SPEC
If you want to ask more about the specification, or have suggestions for If you want to ask more about the specification, or have suggestions for
improvements, join us on ``#matrix-dev:matrix.org``. improvements, join us on ``#matrix-dev:matrix.org``.
.. _JSON Schema: http://json-schema.org/