You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
b0ea6038c6
Having the jekyll assets here is a mistake, because they need to be versioned separately to the spec: we keep old versions of the spec, but they sometimes need to be restyled to match the latest website. |
7 years ago | |
---|---|---|
api | 7 years ago | |
attic | ||
changelogs | 7 years ago | |
drafts | 7 years ago | |
event-schemas | 7 years ago | |
meta | ||
scripts | 7 years ago | |
specification | 7 years ago | |
supporting-docs | 7 years ago | |
templating | 8 years ago | |
.gitignore | 7 years ago | |
CONTRIBUTING.rst | ||
LICENSE | 8 years ago | |
README.rst | ||
jenkins.sh | 7 years ago |
README.rst
This repository contains the documentation for Matrix. Structure ========= - ``api`` : Contains the HTTP API specification. - ``attic``: Contains historical sections of specification for reference purposes. - ``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. - ``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, join us on `#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/