The Matrix protocol 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
Kegan Dougal 4e1e82f995 Fix paragraph CSS and adjust where paragraphs are in the RST
The CSS for `nature.css` was such that it was preventing `p` tags from
having sufficient vertical whitespace. This meant that you couldn't insert
any kind of spacing between lengthy sections (they just appeared as new lines).

This PR fixes this so you can actually have some whitespace between paragraphs.
As a result of this change, some parts of the spec appeared to have too much
whitespace. These were often sections which shouldn't have begun a new
paragraph anyway (e.g. a single sentence being an entire paragraph, `TODO`
blocks resulting in new paragraphs). This PR fixes the most offending areas
where we shouldn't have been inserting new paragraphs.
9 years ago
api Remove obsolete comment 9 years ago
attic Add v1 registration / login stuff into attic dir 10 years ago
drafts Merge pull request #26 from matrix-org/macaroons 9 years ago
event-schemas Merge branch 'master' into markjh/document_v1_rooms_api 9 years ago
meta Update doc style 10 years ago
scripts Fix paragraph CSS and adjust where paragraphs are in the RST 9 years ago
specification Fix paragraph CSS and adjust where paragraphs are in the RST 9 years ago
supporting-docs glue footer to the bottom 9 years ago
templating Detect unused {{ vars }} and whine loudly. 9 years ago
.gitignore .gitignore speculator 9 years ago
CHANGELOG.rst Add sync API yaml. Add template for sync_http_api. 10 years ago
README.rst alas clarify the room link 10 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/