matrix-spec-proposals

Commit Graph

Author	SHA1	Message	Date
Kegan Dougal	458383585f	Stub sections	9 years ago
Kegsay	8aad238cda	Merge pull request #80 from matrix-org/module-receipts Receipts module	9 years ago
Kegan Dougal	da2be7eae4	Merge branch 'master' into module-voip Conflicts: specification/modules/voip_events.rst	9 years ago
Kegan Dougal	6000887201	Merge branch 'master' into module-receipts Conflicts: specification/modules/receipts.rst	9 years ago
Kegan Dougal	c972dad8b3	Flesh out receipts module. Add receipts swagger Add templating support for v2 apis.	9 years ago
Kegsay	4a7a682c0f	Merge pull request #65 from matrix-org/spec-feature-profiles Spec feature profiles	9 years ago
Kegan Dougal	365a9076b9	Add nested dict template support; Add x-pattern For cases where event schema specify `patternProperties` it would be nice to give that pattern a "human-readable" form rather than a raw regex. This is now supported by specifying `x-pattern` in the value part of the specified pattern e.g. `patternProperties:{ "^.*":{ x-pattern: "$THING", ... } }` Templating had limited record type descriptions limited to value primitives e.g. `{string: integer}`. It now supports inspecting the values recursively if the value is `object`. Updated `m.receipt` to take both these points into account to make it read better. Tweak receipt module text.	9 years ago
Kegan Dougal	3b73b07bab	Clarifications that room invites are m.call.invites not actual invites	9 years ago
Kegan Dougal	e82661413e	Add /turnServer endpoint	9 years ago
Kegan Dougal	d092b22848	Rename to 'Managing history visibility'	9 years ago
Kegan Dougal	6c3e70d272	Start fleshing out voip module	9 years ago
Kegan Dougal	91b6347f74	Explain what 'embedded' clients are	9 years ago
Kegan Dougal	be9402b66f	Move feature profiles section to modules as a sub-section	9 years ago
Kegan Dougal	0320e8cef3	Table tweaks from PR	9 years ago
Kegan Dougal	4e1e82f995	Fix paragraph CSS and adjust where paragraphs are in the RST The CSS for `nature.css` was such that it was preventing `p` tags from having sufficient vertical whitespace. This meant that you couldn't insert any kind of spacing between lengthy sections (they just appeared as new lines). This PR fixes this so you can actually have some whitespace between paragraphs. As a result of this change, some parts of the spec appeared to have too much whitespace. These were often sections which shouldn't have begun a new paragraph anyway (e.g. a single sentence being an entire paragraph, `TODO` blocks resulting in new paragraphs). This PR fixes the most offending areas where we shouldn't have been inserting new paragraphs.	9 years ago
Kegan Dougal	cdf9f011e9	Add room history visibility as a module.	9 years ago
Kegan Dougal	82c27884ba	Make E2E optional	9 years ago
Kegsay	c96f02c2b0	Merge pull request #69 from matrix-org/erikj/login_token m.login.token	9 years ago
Erik Johnston	6e6bc8a5a9	Mandate macaroon	9 years ago
Erik Johnston	ce53a17180	Add txn_id rationale	9 years ago
Kegan Dougal	5abea1f2bc	Minor tweaks	9 years ago
Kegan Dougal	70518ae655	Clarify template suffixes	9 years ago
Kegan Dougal	643468e914	Mention swagger. Clarify how event type template vars are formed.	9 years ago
Kegan Dougal	c2fc1a2fb1	Add basic module template. This has the core sections for events/server/client/security.	9 years ago
Kegan Dougal	db8f3c0d59	Desktop clients should have a GUI	9 years ago
Erik Johnston	97154cc6b2	s/nonce/txn_id/	9 years ago
Erik Johnston	4c9f524cab	Neaten things up	9 years ago
Erik Johnston	317c2f20d3	Draft login token spec	9 years ago
Kegan Dougal	510553ee00	Remove smurf suffixes. Add anchor for feature profiles.	9 years ago
Kegan Dougal	9fac152d32	Explain what the clients are and the column reference	9 years ago
Kegan Dougal	c6375ed3d1	Flesh out feature profiles section Add table detailing the profiles. Add anchors to link through to each module following a well-defined format (rather than the name of the module section). Allow UTF-8 in the spec.	9 years ago
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

1 2 3 4

165 Commits (458383585f6e58b588171d37584daccba49ff5bb)