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

Richard van der Hoff 2093a6bac9 Merge pull request #332 from matrix-org/rav/update_login_api Update the /login API spec		9 years ago
api	Merge pull request #332 from matrix-org/rav/update_login_api	9 years ago
attic	Consistently spell homeserver as homeserver	9 years ago
changelogs	C-S API will be released as r1.0.0, not r0.1.0	9 years ago
drafts	random incoherent thoughts on reputation that should live somewhere	9 years ago
event-schemas	Merge pull request #321 from matrix-org/rav/fix_eventschema_readme	9 years ago
meta	Update doc style	10 years ago
scripts	Include the basePath in the path in swagger output	9 years ago
specification	Add git versions to other parts of the spec	9 years ago
supporting-docs	encourage contributions!	9 years ago
templating	Another go at formatting examples	9 years ago
.gitignore	Dump-swagger: take output file name rather than output dir	9 years ago
CONTRIBUTING.rst	Add CONTINUTING.rst	9 years ago
README.rst	alas clarify the room link	10 years ago
jenkins.sh	Remove redundant node event schema checker	9 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/