Restructure the first few sections.
Remove unecessary sections; put presnece/profile sections on the right level. Move Living Standard warning to the top of the Introduction section.
This commit is contained in:
parent
71e200a063
commit
e572cc662a
4 changed files with 15 additions and 18 deletions
|
@ -1,5 +1,6 @@
|
|||
Requirements:
|
||||
- docutils (for converting RST to HTML)
|
||||
- docutils (for converting RST to HTML)
|
||||
- Jinja2 (for templating)
|
||||
|
||||
To generate the complete specification along with supporting documentation, run:
|
||||
python gendoc.py
|
||||
|
|
|
@ -15,24 +15,11 @@ Changelog
|
|||
For a full changelog, see
|
||||
https://github.com/matrix-org/matrix-doc/blob/master/CHANGELOG.rst
|
||||
|
||||
Table of Contents
|
||||
=================
|
||||
|
||||
.. contents:: Table of Contents
|
||||
.. sectnum::
|
||||
|
||||
Introduction
|
||||
============
|
||||
|
||||
Matrix is a set of open APIs for open-federated Instant Messaging (IM), Voice
|
||||
over IP (VoIP) and Internet of Things (IoT) communication, designed to create
|
||||
and support a new global real-time communication ecosystem. The intention is to
|
||||
provide an open decentralised pubsub layer for the internet for securely
|
||||
persisting and publishing/subscribing JSON objects.
|
||||
|
||||
This specification is the ongoing result of standardising the APIs used by the
|
||||
various components of the Matrix ecosystem to communicate with one another.
|
||||
|
||||
.. WARNING::
|
||||
The Matrix specification is still evolving: the APIs are not yet frozen
|
||||
and this document is in places a work in progress or stale. We have made every
|
||||
|
@ -43,6 +30,15 @@ various components of the Matrix ecosystem to communicate with one another.
|
|||
goal is to mirror WHATWG's `Living Standard
|
||||
<http://wiki.whatwg.org/wiki/FAQ#What_does_.22Living_Standard.22_mean.3F>`_.
|
||||
|
||||
Matrix is a set of open APIs for open-federated Instant Messaging (IM), Voice
|
||||
over IP (VoIP) and Internet of Things (IoT) communication, designed to create
|
||||
and support a new global real-time communication ecosystem. The intention is to
|
||||
provide an open decentralised pubsub layer for the internet for securely
|
||||
persisting and publishing/subscribing JSON objects.
|
||||
|
||||
This specification is the ongoing result of standardising the APIs used by the
|
||||
various components of the Matrix ecosystem to communicate with one another.
|
||||
|
||||
The principles that Matrix attempts to follow are:
|
||||
|
||||
- Pragmatic Web-friendly APIs (i.e. JSON over REST)
|
||||
|
|
|
@ -1178,14 +1178,14 @@ address
|
|||
The textual address of the 3pid, eg. the email address
|
||||
|
||||
Presence
|
||||
~~~~~~~~
|
||||
--------
|
||||
.. TODO-spec
|
||||
- Define how users receive presence invites, and how they accept/decline them
|
||||
|
||||
{{presence_http_api}}
|
||||
|
||||
Profiles
|
||||
~~~~~~~~
|
||||
--------
|
||||
|
||||
{{profile_http_api}}
|
||||
|
||||
|
|
|
@ -75,7 +75,7 @@ class MatrixSections(Sections):
|
|||
return self._render_http_api_group(
|
||||
"profile",
|
||||
sortFnOrPathList=["displayname", "avatar_url"],
|
||||
title_kind="+"
|
||||
title_kind="~"
|
||||
)
|
||||
|
||||
def render_sync_http_api(self):
|
||||
|
@ -87,7 +87,7 @@ class MatrixSections(Sections):
|
|||
return self._render_http_api_group(
|
||||
"presence",
|
||||
sortFnOrPathList=["status"],
|
||||
title_kind="+"
|
||||
title_kind="~"
|
||||
)
|
||||
|
||||
def render_room_events(self):
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue