Travis Ralston
ffe577371d
Add a room version specification
...
The "Room Specification" (or "Room Version Specification") is the specification that defines which room versions do what and are intended to be documents which speak the truth about how rooms operate under the hood.
The approach taken here is a bit different than other specifications. For starters, the specification is versioned in this project instead of relying on the matrix.org repository to track compiled HTML. This is done for a couple reasons, the first being we're still developing the v1 specification while concurrently making a v2 spec and the second being trying to reduce the reliance on matrix.org's repository for specifications.
Because the room spec is built into versions, some changes needed to be made. The `targets.yaml` now has a special syntax for indicating what version something is at, and the changelog generator can handle rendering different versions of the same changelog (as parsed from the RST). Some additional work has been put in to the changelog parsing to allow us to reference the v1 room spec as "v1" without having to sacrifice clarity in the changelog headings.
Finally, this moves the state resolution algorithms into the versioned
spec as a result of MSC1759 (https://github.com/matrix-org/matrix-doc/pull/1759 ).
Note: this does not introduce the concept of versioned schemas (tabs) that I was previously working with. There's currently no use for them, so they are shelved elsewhere.
6 years ago
Richard van der Hoff
958b956776
Merge pull request #1755 from matrix-org/erikj/event_checks
...
Document the checks made for incoming PDUs
6 years ago
Travis Ralston
35de43de61
Merge pull request #1743 from matrix-org/dbkr/add_sandbox_to_csp
...
Add 'sandbox' to recommended CSP header
6 years ago
Erik Johnston
39df8291e9
Add TODO
6 years ago
Erik Johnston
be625254b1
Fix up wording about auth rules to not lie
6 years ago
Erik Johnston
c93bdcc59c
Fix up headings
6 years ago
Richard van der Hoff
cac150d567
Fix up wording
...
Co-Authored-By: erikjohnston <erikj@jki.re>
6 years ago
Erik Johnston
ee9c010c37
Document the checks made for incoming PDUs
6 years ago
Richard van der Hoff
fa0b4f9e13
Make the proposal labels match what happens in practice
6 years ago
J. Ryan Stinnett
d197a5761f
Clarify encrypted push rules
...
Fix `.m.rule.encrypted_room_one_to_one` by moving a condition to the right block
of the rule.
Fix `.m.rule.encrypted` to state that it applies to group rooms.
Signed-off-by: J. Ryan Stinnett <jryans@gmail.com>
6 years ago
David Baker
e318286404
Add 'sandbox' to recommended CSP header
6 years ago
Ben Parsons
16f17855c9
link to CS API Swagger Viewer
6 years ago
Ben Parsons
43109a717f
placeholder for proposals CSS
6 years ago
Richard van der Hoff
767af87744
Merge pull request #1701 from uhoreg/e2e_export
...
document megolm session export format
6 years ago
Hubert Chathi
189725659a
clarifications and formatting fixes
6 years ago
Matthew Hodgson
179162379e
spell out that shepherd cannot be author
6 years ago
Erik Johnston
4271391214
Initial stab at documenting soft fail ( #1641 )
6 years ago
Andrew Morgan
f288facec8
Merge pull request #1697 from matrix-org/anoa/msc_update
...
The new and improved MSC process
6 years ago
Andrew Morgan
f8ffa79b56
Update and clarify proposal labels
6 years ago
Andrew Morgan
2b259c6a7b
Remove etiquette page from targets
6 years ago
Andrew Morgan
4b858a7993
DCO required for proposal and spec PR
6 years ago
Andrew Morgan
0afb122760
Clarification on FCPs
6 years ago
Andrew Morgan
f00be6b0d8
Etiquette -> guiding principles
6 years ago
Hubert Chathi
46fde9723c
document megolm session export format
6 years ago
Matthew Hodgson
c6e0a88b09
fix irc bridge example properly
6 years ago
Matthew Hodgson
7a86bc4a66
fix missing escapes on AS regexp
6 years ago
Andrew Morgan
ea21e31a0c
Merge branch 'anoa/msc_update' of github.com:matrix-org/matrix-doc into anoa/msc_update
6 years ago
Andrew Morgan
7bff4d288c
be begin -> begin
6 years ago
Travis Ralston
5a2d28e7fd
Reduce more abbreviations!
6 years ago
Travis Ralston
9625f11fd4
reduce abbreviations
6 years ago
Andrew Morgan
d487c0974f
Clarify how to get a shepherd (just ask)
6 years ago
Andrew Morgan
45c935d8d3
Clarify that MSCs aren't just issues anymore.
6 years ago
Andrew Morgan
1e939c50f5
Gather feedback
6 years ago
Andrew Morgan
148f7d7b33
Minor proposal updates are allowed
6 years ago
Andrew Morgan
5a1e735921
Fix sign off bullet
6 years ago
Andrew Morgan
aeea060bb8
Specify where to find the MSC ID
6 years ago
Andrew Morgan
7753957d04
remove ambiguity
6 years ago
Andrew Morgan
2f0025c7a7
Fix up wording in proposal etiquette
6 years ago
Andrew Morgan
35c924308c
core team -> Core Team
6 years ago
Andrew Morgan
8121bef771
Introduce the spec core team
6 years ago
Andrew Morgan
c1ecb9e324
Fix up table with title and add corresponding GitHub labels
6 years ago
Andrew Morgan
889b46898c
Move proposal etiquette to a separate document.
6 years ago
Andrew Morgan
49d017bdd5
your proposal -> the proposal
6 years ago
Andrew Morgan
fb4c50ec8a
No need to redefine MSC
6 years ago
Andrew Morgan
604091380f
Attempt to fix contributing link
6 years ago
Andrew Morgan
b3f90f5825
proposal passed = spec pr missing
6 years ago
Andrew Morgan
873641e4bc
Proposal Created and In Review is a single phase
6 years ago
Andrew Morgan
11dbd5b56a
Proposal WIP -> drafting/feedback gathering
6 years ago
Andrew Morgan
5ae3b50c6b
Require link to implementation
6 years ago
Andrew Morgan
f1d71bd6c4
Less complicated wording
6 years ago
Andrew Morgan
0e9ad9e95d
Fix wording, fix earlier capatilization
6 years ago
Andrew Morgan
f769084570
Put it in the proposals dir!
6 years ago
Andrew Morgan
67146e4bec
MSC ALL the changes
6 years ago
Andrew Morgan
9432ed76d7
first-draft -> first draft
6 years ago
Andrew Morgan
80d1d4af9c
Fix capatilization
6 years ago
Andrew Morgan
d2e827e0c6
Note about earlier MSC process
6 years ago
Andrew Morgan
764c63f3e8
Add proposal template
6 years ago
Andrew Morgan
a3144e6959
Move to the new and improved MSC process
6 years ago
Matthew Hodgson
6dab4b28f8
Merge pull request #1648 from matrix-org/matthew/device_list_update
...
document device list synchronisation over federation.
6 years ago
Matthew Hodgson
334c69bcda
wording fix
6 years ago
Matthew Hodgson
ccbc88ee5d
reword to spell out to when device list updates should be sent
6 years ago
Matthew Hodgson
bcd48ebbec
Merge pull request #1610 from uhoreg/reloaded
...
document new state resolution algorithm
6 years ago
Konstantinos Sideris
192a6c2ab9
Use example.org on examples instead of domain.com which is a real domain
...
Signed-off-by: Konstantinos Sideris <sideris.konstantin@gmail.com>
6 years ago
Matthew Hodgson
e9e3afbd34
clarify who servers should send m.device_list_update EDUs to
6 years ago
Matthew Hodgson
928fc5cbe5
incorporate review
6 years ago
Matthew Hodgson
42b11e096f
Review
6 years ago
Matthew Hodgson
d25f4412d4
improve wording
6 years ago
Matthew Hodgson
db302b66ca
revert example which was corect first time; fix rst
6 years ago
Matthew Hodgson
0f9a23c471
swaggerify to-device
6 years ago
Matthew Hodgson
0afdcc59ea
spell out stream_id and fix todo
6 years ago
Matthew Hodgson
30d56691b1
document device list synchronisation over federation.
...
untested
closes MSC1212
6 years ago
Travis Ralston
735de03e07
Add r0 version links
...
These were missed in the release process.
6 years ago
Travis Ralston
bb2835651f
Merge pull request #1637 from turt2live/travis/c2s/clarify-errors
...
List known client-server error codes; Clarify priority of error codes vs http status code
6 years ago
Travis Ralston
00578547c0
Merge pull request #1644 from matrix-org/rav/is_token_grammar
...
Spec grammars for IS things
6 years ago
Travis Ralston
f3825c5827
A couple more stragglers
6 years ago
Travis Ralston
218b86d6e8
Hopefully the last one
6 years ago
Richard van der Hoff
79974b152c
s/identity service/identity server
6 years ago
Richard van der Hoff
a544b68298
Merge branch 'master' into rav/is_token_grammar
6 years ago
Travis Ralston
7d34995ece
It's actually an "identity server implementing the Identity Service API"
...
Also add a note about appservices being special.
6 years ago
Travis Ralston
7ac76fa27c
Actually we're going with "identity server" afterall
6 years ago
Travis Ralston
ec248b436f
Identity Service is lowercase
6 years ago
Travis Ralston
cc0badaaa1
Fix all naming cases of "identity service"
...
Fixes https://github.com/matrix-org/matrix-doc/issues/1396
Includes some "homeserver" fixes too. This commit does not include historical documentation or notes.
6 years ago
Travis Ralston
108c623557
Merge pull request #1635 from turt2live/travis/c2s/read-markers
...
Add read markers
6 years ago
Travis Ralston
835f5de387
Generalize the token name even more
6 years ago
Richard van der Hoff
dced3d5707
Notes on the format of IS session IDs and tokens
6 years ago
Travis Ralston
f299fe023a
English
6 years ago
Travis Ralston
f4c5c209f3
Generalize language for pagination
...
Previously the section was very strict in what pagination was, however this isn't the reality for the matrix specification. Several endpoints have their own pagination naming conventions and do not follow those mandated by this section.
This commit generalizes the language to cover those endpoints while also describing how pagination works. In particular, it describes the rough API shape to expect and how to deal with the responses.
This commit also removes the `M_BAD_PAGINATION` error as it is not used in the real world. Homeservers are instead encouraged to use the standard `M_INVALID_PARAM` or similar error code.
Fixes https://github.com/matrix-org/matrix-doc/issues/610
Fixes https://github.com/matrix-org/matrix-doc/issues/1523
6 years ago
Hubert Chathi
c0dd7e0025
Merge pull request #1420 from Zil0/encrypted_attach
...
Document encrypted attachments
6 years ago
Travis Ralston
4b9fb99644
Take out unhelpful example
6 years ago
Travis Ralston
3146fc339a
Merge remote-tracking branch 'matrix-org/master' into travis/c2s/clarify-errors
6 years ago
Travis Ralston
f6d9e53f5c
Clarify that homeserver must reject clients from setting m.fully_read
6 years ago
Travis Ralston
2e8151999e
Clarify that read markers are fully read markers
6 years ago
Hubert Chathi
f1f32d3a15
add more clarifications
6 years ago
Travis Ralston
679ddabb53
Merge remote-tracking branch 'matrix-org/master' into travis/c2s/read-markers
6 years ago
Travis Ralston
567843e043
Add additional clarity to how rich replies are structured and used
6 years ago
Hubert Chathi
e3daf10bb9
refactor encrypted file schema as "Extension to m.message"
6 years ago
Travis Ralston
9004be7bda
Merge remote matrix-org/master
6 years ago
Travis Ralston
f013b7ef03
Merge pull request #1631 from turt2live/travis/general/unstable-warning
...
Render a warning if the spec is unstable
6 years ago
Travis Ralston
ab00630ebc
Don't include a second unstable warning in the s2s spec for now
6 years ago
Travis Ralston
f72c821be4
Merge pull request #1619 from turt2live/travis/c2s/local-echo
...
Reference that transaction IDs may be used to echo
6 years ago