wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Update README

Browse source 
Structure and Contributing were both a bit out of date.
This commit is contained in:
Richard van der Hoff 2016-07-14 10:52:30 +01:00
parent b5d68b8ff1
commit 0e26238386
1 changed files with 20 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

31
README.rst
View file

@ -4,27 +4,36 @@ Structure
========= =========
- ``api`` : Contains the HTTP API specification. - ``api`` : Contains the HTTP API specification.
- ``drafts`` : Contains documents which will make it into the specification - ``attic``: Contains historical sections of specification for reference
and/or supporting documentation at some point in the future. purposes.
- ``event-schemas`` : Contains the `JSON Schema`_ for all Matrix events - ``changelogs``: Contains change logs for the various parts of the
specification.
- ``drafts``: Previously, contained documents which were under discussion for
future incusion into the specification and/or supporting documentation. This
is now historical, as we use separate discussion documents (see
`<CONTRIBUTING.rst>`_).
- ``event-schemas``: Contains the `JSON Schema`_ for all Matrix events
contained in the specification, along with example JSON files. 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
documentation, typically HTML. documentation, typically HTML.
- ``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 - ``templating``: Contains the templates and templating system used to
generate the spec. generate the spec.
Contributing Contributing
============ ============
Known issues with the specification are represented as JIRA issues at Known issues with the specification are represented as JIRA issues at
https://matrix.org/jira/browse/SPEC `<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, join us on
improvements, join us on ``#matrix-dev:matrix.org`` via https://matrix.org/beta. `#matrix-dev:matrix.org <http://matrix.to/#/#matrix-dev:matrix.org>`_.
If you would like to contribute to the specification or supporting
documentation, see `<CONTRIBUTING.rst>`_.
.. _JSON Schema: http://json-schema.org/ .. _JSON Schema: http://json-schema.org/