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.
5115346297
Previously, all `m.room.*` events were wodged into `{{room_events}}` which
isn't great when you want to pull specific ones out. Batesian had a 1:1
mapping of `render_foo()` to a section `{{foo}}`, and having to constantly
add functions for new types is a PITA. Batesian now supports returning a
`dict` instead of a section `string` where the keys are the `{{foo}}` and
the value is what will be inserted. Also add conflicting section key checks
to avoid multiple definitions of the same `{{foo}}`. Define dicts for
event schemata and swagger HTTP APIs.
Using this new feature, split out the instant messaging stuff from the events
section, and replace `{{room_events}}` with a list of specific events e.g.
`{{m_room_member_event}}`.
|
10 years ago | |
|---|---|---|
| api | 10 years ago | |
| attic | 11 years ago | |
| drafts | 10 years ago | |
| event-schemas | 10 years ago | |
| meta | 11 years ago | |
| scripts | 10 years ago | |
| specification | 10 years ago | |
| supporting-docs | 10 years ago | |
| templating | 10 years ago | |
| .gitignore | 10 years ago | |
| CHANGELOG.rst | 11 years ago | |
| README.rst | 11 years ago | |
| jenkins.sh | 10 years ago | |
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/