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

Mark Haines 2c31731262 Add the jenkins command to source control so that we can update it without having to fiddle with the jenkins UI. It also allow us to move files without breaking the CI since we won't be hard coding the locations of scripts in the jenkins UI.		9 years ago
api	Make to code to skip checking swagger responses which don't have an	9 years ago
attic	Add v1 registration / login stuff into attic dir	9 years ago
drafts	Merge pull request #9 from matrix-org/v2-presence	9 years ago
event-schemas	Skip files that start with ".", e.g. vim swp files.	9 years ago
meta	Update doc style	9 years ago
scripts	Merge pull request #51 from matrix-org/daniel/gendoc	9 years ago
specification	Modify and enforce the file format/structure used	9 years ago
supporting-docs	glue footer to the bottom	9 years ago
templating	Merge remote-tracking branch 'origin/master' into markjh/swagger_examples	9 years ago
.gitignore	.gitignore speculator	9 years ago
CHANGELOG.rst	Add sync API yaml. Add template for sync_http_api.	9 years ago
README.rst	alas clarify the room link	9 years ago
jenkins.sh	Add the jenkins command to source control so that we can update	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/