Navigation Menu

Skip to content

frankgerhardt/matrix-doc

 
 

Repository files navigation

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.

About

Matrix Documentation (including The Spec)

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 64.6%
  • Python 14.7%
  • CSS 11.2%
  • Go 4.3%
  • Perl 3.1%
  • HTML 1.8%
  • Shell 0.3%