matrix-spec-proposals

Proposals for changes to the matrix specification

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.

Go to file

Hubert Chathi 0db7eed69d add information about Perspectives add some information about how Perspectives works, link to their web site, and fix capitalization to match how the Perspectives Project capitalizes their name		8 years ago
api	Use the right path for the identity API	8 years ago
attic	…
changelogs	changelog: Fix a couple of punctuations	8 years ago
drafts	…
event-schemas	Move m.direct description to the swagger	8 years ago
meta	…
scripts	Serve the api docs from the speculator	8 years ago
specification	Merge pull request #405 from matrix-org/dbkr/push_examples_api_path	8 years ago
supporting-docs	add information about Perspectives	8 years ago
templating	Order props in the spec the same as the API	8 years ago
.gitignore	…
CONTRIBUTING.rst	…
LICENSE	…
README.rst	…
jenkins.sh	…

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/