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

Kitsune Ral 24afe7987c Add operationId to all endpoints of all APIs To facilitate generation of API stubs from the spec. Signed-off-by: Alexey Rusakov <ktirf@users.sf.net>		7 years ago
api	Add operationId to all endpoints of all APIs	7 years ago
attic	Consistently spell homeserver as homeserver	9 years ago
changelogs	document joined_members and joined_rooms endpoints (#999 )	7 years ago
drafts	clarify ID rules	7 years ago
event-schemas	Fix membership on third-party invite upgrade (#995 )	7 years ago
meta	Link to doc style doc	8 years ago
scripts	Simplify dump_swagger	7 years ago
specification	document joined_members and joined_rooms endpoints (#999 )	7 years ago
supporting-docs	Merge pull request #1012 from maxidor/master	7 years ago
templating	Improve logging for gendoc	7 years ago
.gitignore	Move jekyll back out of matrix-doc again	7 years ago
CONTRIBUTING.rst	Link to doc style doc	8 years ago
LICENSE	Add a license to the spec	8 years ago
README.rst	Update README	8 years ago
jenkins.sh	Move jekyll back out of matrix-doc again	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/