matrix
/
matrix-doc
mirror of https://github.com/matrix-org/matrix-doc.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Matrix Documentation (including The Spec)
1,540 Commits 670 Branches 26 Tags 28 MiB
Markdown 100%
Go to file
Paul "LeoNerd" Evans a077f8470a Various rewordings from latest review comments 2016-04-21 17:23:04 +01:00
api Remove redundant info & add backticks 2016-04-13 10:29:57 +01:00
attic Consistently spell homeserver as homeserver 2015-12-02 19:23:33 +00:00
changelogs Clarify `history_visibility` behaviour 2016-04-06 17:55:01 +01:00
drafts random incoherent thoughts on reputation that should live somewhere 2016-02-09 12:07:58 +00:00
event-schemas Add event as a parent for all event types 2016-03-16 16:46:16 +01:00
meta Update doc style 2015-02-19 17:14:25 +00:00
scripts Continuserv: Reduce number of watches 2016-04-11 23:21:21 +01:00
specification Merge pull request #305 from matrix-org/rav/show_own_leave_event 2016-04-08 11:47:17 +01:00
supporting-docs Various rewordings from latest review comments 2016-04-21 17:23:04 +01:00
templating Change `id` in the push gateway poke to be `event_id` and spec that it's the Matrix event ID of the message. Correct the spec for badge count pushes which omit fields previously described as mandatory. Add more detail about when to use event_id to suppress dupes. Also add the push gateway doc so it's actually included in the spec. 2016-04-06 18:28:21 +01:00
.gitignore Add _cs suffix to client-server http APIs 2016-03-08 17:42:41 +00:00
CONTRIBUTING.rst Add CONTINUTING.rst 2016-03-04 16:08:46 +00:00
README.rst alas clarify the room link 2015-06-02 16:11:27 +01:00
jenkins.sh Remove redundant node event schema checker 2015-11-30 16:40:48 +00:00

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/