matrix-spec-proposals

Commit Graph

Author	SHA1	Message	Date
Kegan Dougal	1da64db302	Use relative depths for groups instead of absolute ones This means the group can be agnostic to how deeply nested it is, improving reusability of groups.	9 years ago
Kegan Dougal	29bae15790	Fix typo	9 years ago
Kegan Dougal	5115346297	Add instant_messaging module; modify batesian section rules Previously, all `m.room.*` events were wodged into `{{room_events}}` which isn't great when you want to pull specific ones out. Batesian had a 1:1 mapping of `render_foo()` to a section `{{foo}}`, and having to constantly add functions for new types is a PITA. Batesian now supports returning a `dict` instead of a section `string` where the keys are the `{{foo}}` and the value is what will be inserted. Also add conflicting section key checks to avoid multiple definitions of the same `{{foo}}`. Define dicts for event schemata and swagger HTTP APIs. Using this new feature, split out the instant messaging stuff from the events section, and replace `{{room_events}}` with a list of specific events e.g. `{{m_room_member_event}}`.	9 years ago
Kegan Dougal	5b134119bd	Add presence module; fix relative title bug If a relative title appeared after an HTTP API table, it would insert the wrong level because it thought that part of the table was a title.	9 years ago
Kegan Dougal	b49cb57fe5	Move events sections to CS API	9 years ago
Kegan Dougal	16693a644a	Various review fixes	9 years ago
Kegan Dougal	b0eb985523	Merge branch 'master' into spec-restructure-modules	9 years ago
Kegan Dougal	0c0ac3e814	Fix common event fields template to use subtitle char	9 years ago
Kegan Dougal	e8cdfcbba2	Rename spec files to not have numbers everywhere; update targets.yaml	9 years ago
Kegan Dougal	f71763b0d3	Implement relative title styles Templates don't know at what level they will be inserted. Previously, we hard-coded the title style which is not compatible with the build target system. Define a set of styles which will be replaced by the gendoc script when it encounters them: '<' : Make this title a sub-heading '/' : Make this title a heading at the same level '>' : Make this title a super-heading The build target system is now basically complete and functioning.	9 years ago
Kegan Dougal	067363c629	Get the desired title levels right; print out the actual level used to stdout	9 years ago
Kegan Dougal	8590cc84b5	Process and extract targets in gendoc.py	9 years ago
Kegan Dougal	568982ee2e	Represent nested deps in targets.yaml along with title styles This will allow us to programatically position .rst snippets anywhere which will for once and for all remove the horrid title level mismatch bugs. We require this in order to allow people to re-shuffle the spec without having to adjust the spec itself (e.g. 2 targets with different levels of nesting).	9 years ago
Kegan Dougal	703f913a47	Add a 'targets.yaml' files in /specification We're well beyond the point now where a simple `cat` of .rst files to "build" the spec is practical. We may want to slice and dice the spec in different ways to address various cross-cutting concerns. To this end, there is now a 'targets' file which contains the "build targets" for the spec, which contains the sorting order for the .rst files. For now, we just have a single target: 'main'.	9 years ago
Kegan Dougal	f520ac9d82	Create a modules folder to group together similar parts of the spec	9 years ago
Kegan Dougal	c77ef1a2cc	Add stub files feature_profiles and modules	9 years ago
Kegan Dougal	f2c952ec58	Reshuffle spec into sections roughly right as per PR #52	9 years ago
Mark Haines	f33c0846c3	Merge remote-tracking branch 'origin/master' into markjh/document_v1_rooms_api	9 years ago
Kegan Dougal	1f6b12b3e8	Modify and enforce the file format/structure used Convert the file format to be of the form ##_##_something.rst where the first ## is the top-level section number and the second ## is the second-level section number, e.g. 07_01_push_cs_api.rst means Section 7.1 - This is now enforced in gendoc.py along with the title line style that should be used (= for top-level, - for 2nd level) which will give helpful suggestions if you trip up. This feels much more intuitive now looking in /specification	9 years ago
Kegan Dougal	9ed39665c8	PR feedback	9 years ago
Kegan Dougal	8e7b33ac99	Fix more typos/spelling errors	9 years ago
Kegan Dougal	3f9d183c2a	More typo/layout fixes Split out identity servers to a separate file	9 years ago
Kegan Dougal	620d3dcb26	Test commit	9 years ago
Kegan Dougal	faa95e172f	More formatting fixes; typos; etc	9 years ago
Kegan Dougal	af32ec194a	Move VoIP events to 22_voip_events 20_events is a huge as it is, this makes it easier to find what section you actually want when editing.	9 years ago
Kegan Dougal	5b59c67510	Minor formatting fixes. Fix state event templating.	9 years ago
Mark Haines	7eb8b4fde2	Add new-style docs for the APIs for getting events for a room	9 years ago
Daniel Wagner-Hall	59a4e84361	s/registration/login/	9 years ago
Daniel Wagner-Hall	b8e2ac5c1b	Swaggerify /login	9 years ago
Kegsay	e788f565f8	Merge pull request #36 from matrix-org/daniel/threepidinvites Swagger /room/{roomId}/invite	9 years ago
Kegsay	3011823c51	Merge pull request #27 from matrix-org/receipts Document receipts	9 years ago
Daniel Wagner-Hall	2797fac3aa	Swagger /room/{roomId}/invite This is a transcription of the current spec, with nothing new or controversial in it.	9 years ago
Daniel Wagner-Hall	04b2b2588f	Fix up formatting and typos	9 years ago
Daniel Wagner-Hall	d53943c8c2	Spec /room/{roomId}/join This is just replacing the existing spec with a swagger version. Subsequent pull requests will add 3pid join to this, as well as specing the invite, leave, ban, and kick endpoints.	9 years ago
Erik Johnston	80bb51d9bb	Make it clearer	9 years ago
Erik Johnston	4b24b887c7	Document m.room.history_visibility	9 years ago
Erik Johnston	83dfc2bf61	Fix some mistakes/typos	9 years ago
Erik Johnston	0dc22e7217	Document receipts	9 years ago
Paul "LeoNerd" Evans	49c52a96a7	Rename 'perspective server' to 'notary server' as that's what the Perspectives Project calls them too	9 years ago
Kegsay	880bf20403	Merge pull request #21 from matrix-org/paul/fixes Three small fixes	9 years ago
Paul "LeoNerd" Evans	c6f2f711de	Mention AAAA as well as A records; remark on default port 8448 for no-SRV fallback	9 years ago
Matthew Hodgson	f08588bf7e	typo	9 years ago
Paul "LeoNerd" Evans	5f391b5617	Also document the directory server federation API	9 years ago
Paul "LeoNerd" Evans	fc1e01f373	Add a small note about the meaning of the 'target' field	9 years ago
Paul "LeoNerd" Evans	af1616ba9a	Merge branch 'master' into paul/fixes	9 years ago
Paul "LeoNerd" Evans	28894ac1b7	Bugfix to embedded sign_json() python code	10 years ago
Paul "LeoNerd" Evans	9b046cbc04	Tiny fix to embedded YAML fragment	10 years ago
Kegan Dougal	e572cc662a	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.	10 years ago
Kegan Dougal	71e200a063	Remove version section.	10 years ago
Kegan Dougal	e10859a887	Replace presence API with new template.	10 years ago

1 2 3

134 Commits (14e77b09ab188928d75e462c0e136b6aaf3b74ea)