Go to file
Keyvan Fatehi 94565933c2 Tempering the sales pitch of puppetted bridges.
Folks are getting confused. The article sells the puppeted bridge
concept a little too hard and needs to temper it with the reality that
most networks people want to bridge (Facebook, Hangouts) suffer from the
fact that there is no means of representation for non-puppeted users.

Relevant discussions:

* https://matrix.to/#/!ChuQQIVJvwyJujhNIG:synapse.keyvan.pw/$149063160814JjbEL:gruenhage.xyz
* https://matrix.to/#/!svJUttHBtRMdXmEhEy:matrix.org/$149072185910105qOwCB:synapse.keyvan.pw

Signed-off-by: Keyvan Fatehi <keyvanfatehi@gmail.com>
2017-03-28 10:56:56 -07:00
api Merge pull request #740 from matrix-org/rav/fix_736 2016-11-22 09:52:19 +00:00
attic Consistently spell homeserver as homeserver 2015-12-02 19:23:33 +00:00
changelogs Allow guest access to E2E endpoints 2016-11-30 16:12:17 +00:00
drafts delete macaroons draft 2016-11-30 16:42:06 +00:00
event-schemas Clarify that age is generated on the local HS 2016-11-30 23:12:47 +01:00
meta Link to doc style doc 2016-07-14 10:13:10 +01:00
scripts Add continuserv index 2016-10-14 17:57:07 +01:00
specification Specification of unpadded Base64 2017-03-01 08:50:07 +00:00
supporting-docs Tempering the sales pitch of puppetted bridges. 2017-03-28 10:56:56 -07:00
templating Better examples 2016-10-14 15:57:52 +01:00
.gitignore Dump-swagger: take output file name rather than output dir 2016-05-03 12:03:21 +01:00
CONTRIBUTING.rst Link to doc style doc 2016-07-14 10:13:10 +01:00
jenkins.sh Remove thing from jenkins.sh 2016-08-02 14:18:55 +01:00
LICENSE Add a license to the spec 2016-07-12 17:28:30 +01:00
README.rst Update README 2016-07-14 10:52:30 +01:00

This repository contains the documentation for Matrix.

Structure
=========

- ``api`` : Contains the HTTP API specification.
- ``attic``: Contains historical sections of specification for reference
  purposes.
- ``changelogs``: Contains change logs for the various parts of the
  specification.
- ``drafts``: Previously, contained documents which were under discussion for
  future incusion into the specification and/or supporting documentation. This
  is now historical, as we use separate discussion documents (see
  `<CONTRIBUTING.rst>`_).
- ``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, join us on
`#matrix-dev:matrix.org <http://matrix.to/#/#matrix-dev:matrix.org>`_.

If you would like to contribute to the specification or supporting
documentation, see `<CONTRIBUTING.rst>`_.

.. _JSON Schema: http://json-schema.org/