Commit graph

39 commits

Author SHA1 Message Date
Johannes Marbach
23e709ae9b
MSC4213: Remove server_name parameter (#2059)
Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
2025-02-11 18:03:25 +00:00
Tulir Asokan
cd6ae9e1a2
Clarify that arbitrary unicode is allowed in user/room IDs and room aliases (#1506)
Signed-off-by: Tulir Asokan <tulir@maunium.net>
Co-authored-by: Travis Ralston <travisr@matrix.org>
Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
2025-01-22 10:33:34 +00:00
Kévin Commaille
611d6c3e7e
Always use % delimiter for added-in and changed-in shortcodes (#1975)
The `<>` delimiters are not necessary for the shortcode to be rendered inline, and in some cases they break some expectations: a shortcode that is separated from other text to be in its own paragraph is not actually wrapped by a `p` element, breaking the spacing between paragraphs.

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2024-10-30 10:09:38 +00:00
Johannes Marbach
7916032a78
Move size limits for user, room and event IDs into the appendix and clarify that the length is to be measured in bytes (#1850)
Fixes: #1826
Relates to: #1001
Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
2024-06-12 09:11:07 +01:00
Matthew Hodgson
e15a36b0a1
MSC4132: deprecate linking to events in rooms identified by alias (#1823) 2024-06-04 16:20:23 +01:00
Richard van der Hoff
dac867dd6a
Rename "recovery key" to "backup decryption key" (#1819)
Also, some other editorial improvements, including factoring out our two definitions of the same key encoding algorithm.

Co-authored-by: Travis Ralston <travisr@matrix.org>
2024-05-14 09:35:42 +01:00
Richard van der Hoff
073ce659df
Define opaque identifier grammar (#1791)
Since we already have three of these, and I'm about to add a fourth, let's pull
it out to a common definition.

We could, of course, keep defining the grammar each time it's used, but
defining it in an appendix helps us be consistent for future API design.
2024-04-17 09:22:06 +01:00
tsufeki
92cf662e3a
Fix typo in canonical JSON grammar (#1652)
Signed-off-by: Benedykt Błaszkiewicz <tsufeki@gmail.com>
2023-10-02 12:13:23 +00:00
Patrick Cloke
6521411547
Allow + in Matrix IDs. (#1583) 2023-07-04 14:40:43 +01:00
Tony Garnock-Jones
e9acece3ec
Cope with negative-zero, and give an example of negative-zero and a large power of ten (#1573) 2023-07-04 12:59:37 +00:00
Richard van der Hoff
64c61c2de2
Properly separate Room ID and Event ID grammars (#1484) 2023-04-06 09:57:30 +01:00
Richard van der Hoff
e9fc66cf77
Remove references to groups from appendices (#1483) 2023-04-06 09:57:12 +01:00
Patrick Cloke
d222fc60d6
Document MSC3758, MSC3966, MSC3873, and MSC3980. (#1464)
* Add information on MSC3758: event_property_is.

* Add information on MSC3966: event_property_contains.

* Add information on MSC3873 dotted-path escape rules.

* Newsfragment

* Update sync filter with ref to appendix.

* Escape example key.

* Fix typos.

Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>

* Fix links.

* Clarify the appendix a bit.

* Clarify support values.

* Add MSC3980 to changelog.

---------

Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
2023-04-03 23:03:37 -06:00
Stuart Mumford
d6f38f157d
Add a sentence about what canonical JSON is (#1468)
Signed-off-by: Stuart Mumford <stuart@cadair.com>
2023-03-21 16:27:54 +00:00
Patrick Cloke
afae1083aa
Clarify what key content-specific rules match against. (#1441) 2023-03-08 13:06:06 +00:00
Andrew Morgan
c0955a6aee
Add a hyphen between third and party when used as an adjective (#1447) 2023-03-08 09:58:29 +00:00
Richard van der Hoff
614680675f
Fix broken links to matrix-doc (#1032)
The spec has moved to https://github.com/matrix-org/matrix-spec, so there were
a lot of broken links here.
2022-04-20 16:36:14 +01:00
Travis Ralston
59f4d7ffed Revert fix to appendices 2022-01-26 12:19:13 -07:00
Matthew Hodgson
20aa44bd13
typoes (#3680)
* typoes

* Appease the faulty spellcheck on the json too

Co-authored-by: Travis Ralston <travisr@matrix.org>
2022-01-26 12:14:09 -07:00
Travis Ralston
20bd445602
Add a changelog for the appendices (#3609)
As a document which is versioned, we should have a changelog for it. It might be empty most of the time but oh well.
2022-01-04 20:23:02 -07:00
Travis Ralston
592cbd537c
Describe matrix: URI scheme (#3608)
* Copy spec PR near-verbatim from past PR

With light review being addressed.

https://github.com/matrix-org/matrix-doc/pull/3168

* Alter for modern day

* Add changelog

* specify that we're using the grammar
2021-12-30 22:11:09 -07:00
Travis Ralston
0fbc6bdab6
Definition of "Standard Identifier Format" (#3171)
Spec for https://github.com/matrix-org/matrix-doc/pull/2758
2021-12-15 11:38:29 +00:00
Travis Ralston
649fc2bdd2
Move room version spec to /rooms (#3423)
* Cut/paste room version spec to its own page

* Move grammar to bottom + add feature matrix

The version grammar is not as interesting as the actual room versions, so this moves that whole section to the bottom.

* Fix all links to room versions
2021-10-12 14:47:03 -06:00
Jonas Platte
6e78cde3eb
Fix wrong matrix.to URL in spec appendices (#3409) 2021-09-23 10:39:47 -06:00
Richard van der Hoff
f8b83b7fb1 Replace "Pagination" section in C-S API with text in appendices (#3366)
The Pagination section in the C-S API was, basically, full of rubbish. I think that anything of any value it contained was repeated either directly on the API definitions or in the text specific to syncing at https://spec.matrix.org/unstable/client-server-api/#syncing.

The conventions I've added to the Appendices are based on the discussions in #1898. They are there because I don't want to have to go through it all again next time we add a paginated API.

Fixes: #1898
Fixes: #2268
2021-08-27 19:17:18 +01:00
Neil Alexander
3d278b891d Add clarification on binary data and base64 encoding to Appendices (#3362)
* Add clarification on binary data and base64 encoding (closes #3341)

* Add changelog fragment

* Delete 3362.clarification
2021-08-27 19:17:18 +01:00
Richard van der Hoff
4b2bbbabcc Start a 'conventions' section in the Appendices (#3350)
I wanted a section for "here's what new APIs ought to do", which isn't really
very useful for consumers of the existing APIs.
2021-08-27 19:17:18 +01:00
Travis Ralston
8b40972872 iterate 2021-08-27 19:17:14 +01:00
Travis Ralston
21a132d3a5 Merge branch 'master' into travis/clarification/lowercasing 2021-08-27 19:17:14 +01:00
Travis Ralston
4cb667ca27 Case fold instead of lowercase
Fixes https://github.com/matrix-org/matrix-doc/issues/3175
2021-08-27 19:17:14 +01:00
Travis Ralston
3c01fa4681 Remove group identifiers
Groups are replaced by https://github.com/matrix-org/matrix-doc/pull/1772 and this probably shouldn't have made it into the spec in the first place without the remaining context of Groups.
2021-08-27 19:17:13 +01:00
Travis Ralston
53833d49a5 Spelling 2021-08-27 19:17:12 +01:00
Travis Ralston
7cef7d0fcf Specify that email handling converts to lowercase first
Spec for https://github.com/matrix-org/matrix-doc/pull/2265
2021-08-27 19:17:12 +01:00
Will
4e39200cfa
Fix internal links 2021-01-20 21:45:35 -08:00
Will
338434bfcd
Support alerts (notes, warnings, rationales) 2021-01-20 12:34:49 -08:00
Will
ab64bda76d
Add syntax highlighting 2021-01-20 10:48:15 -08:00
Will
19836aa949
Fix headings for Appendices 2021-01-19 15:26:59 -08:00
Will
c924b3246f
Add page content as raw Pandoc output 2021-01-19 15:14:52 -08:00
Will
ebc6db233b
Add empty page placeholders 2021-01-19 14:15:46 -08:00