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,577 Commits 670 Branches 26 Tags 28 MiB
Markdown 100%
Go to file
Richard van der Hoff 014b3f5f96 Make the schema files JSON 
This undoes a change made in PR #217.

Although JSON is a disasterous syntax for human-maintained files, the fact
remains that JSON-schema is a thing, whilst YAML-schema (although accepted by
swagger) is not. Using YAML negates most of the advantages of using the
JSON-schema format (mostly, the fact that we can feed those files into a number
of tools), and we weren't really using the increased power of YAML.

Possibly, we should consider generating the JSON from YAML inputs, but either
way, the event schemas need to refer to the JSON files, and for now it's easier
just to stick to JSON.
 		2016-05-04 18:25:24 +01:00
api Make the schema files JSON 2016-05-04 18:25:24 +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 Make the schema files JSON 2016-05-04 18:25:24 +01:00
meta Update doc style 2015-02-19 17:14:25 +00:00
scripts Update README.md 2016-05-04 01:08:50 +01:00
specification Clarify which documents are generated from scripts. 2016-05-04 02:30:44 -07:00
supporting-docs Remove port number from room IDs in pasted examples 2016-04-25 13:55:57 +01:00
templating Make the schema files JSON 2016-05-04 18:25:24 +01:00
.gitignore Dump-swagger: take output file name rather than output dir 2016-05-03 12:03:21 +01: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/