From 9631e4bcb1927bb69995346a02fb8183347c7527 Mon Sep 17 00:00:00 2001 From: Travis Ralston Date: Fri, 1 Feb 2019 18:00:26 -0700 Subject: [PATCH 1/2] Add a bit of text to ensure that the intro page isn't missed --- specification/index.rst | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/specification/index.rst b/specification/index.rst index aa4471c4..db6ff99f 100644 --- a/specification/index.rst +++ b/specification/index.rst @@ -40,10 +40,14 @@ The specification consists of the following parts: {{apis}} +Additionally, this introduction page is a valuable resource for all Matrix developers, +including the sections on `room versions <#room-versions>`_ and `overall architecture <#architecture>`_. + The `Appendices `_ contain supplemental information not specific to one of the above APIs. -The `Matrix Client-Server API Swagger Viewer `_ is useful for browsing the Client-Server API. +The `Matrix Client-Server API Swagger Viewer `_ +is useful for browsing the Client-Server API. Introduction to the Matrix APIs ------------------------------- From 1f5783b329f1d5b5e58206ff0a0f54d895868f10 Mon Sep 17 00:00:00 2001 From: Travis Ralston Date: Fri, 1 Feb 2019 18:07:55 -0700 Subject: [PATCH 2/2] fix links and wording --- specification/index.rst | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/specification/index.rst b/specification/index.rst index db6ff99f..d6176c93 100644 --- a/specification/index.rst +++ b/specification/index.rst @@ -40,8 +40,9 @@ The specification consists of the following parts: {{apis}} -Additionally, this introduction page is a valuable resource for all Matrix developers, -including the sections on `room versions <#room-versions>`_ and `overall architecture <#architecture>`_. +Additionally, this introduction page contains the key baseline information required to +understand the specific APIs, including the sections on `room versions`_ +and `overall architecture <#architecture>`_. The `Appendices `_ contain supplemental information not specific to one of the above APIs. @@ -132,6 +133,8 @@ To propose a change to the Matrix Spec, see the explanations at `Proposals for Spec Changes to Matrix `_. +.. _`architecture`: + Architecture ------------ @@ -422,6 +425,7 @@ dedicated API. The API is symmetrical to managing Profile data. Would it really be overengineered to use the same API for both profile & private user data, but with different ACLs? +.. _`room versions`: Room Versions -------------