mirror of
https://github.com/matrix-org/matrix-spec
synced 2026-01-03 14:38:37 +01:00
f71763b0d3
Templates don't know at what level they will be inserted. Previously, we hard-coded the title style which is not compatible with the build target system. Define a set of styles which will be replaced by the gendoc script when it encounters them: '<' : Make this title a sub-heading '/' : Make this title a heading at the same level '>' : Make this title a super-heading The build target system is now basically complete and functioning. |
||
|---|---|---|
| api | ||
| attic | ||
| drafts | ||
| event-schemas | ||
| meta | ||
| scripts | ||
| specification | ||
| supporting-docs | ||
| templating | ||
| .gitignore | ||
| CHANGELOG.rst | ||
| jenkins.sh | ||
| 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/