matrix-org / matrix-org/matrix-spec
Clarify/cross-reference the signing section of the appendices with the s2s spec
Open
Nobody has claimed this yet.
A-S2S
clarification
- Dominant language
- HTML
- Stars
- 330
- Forks
- 150
- Avg merge
- 2h 21m
- Merged PRs (30d)
- 3
Description
Most people probably want https://matrix.org/docs/spec/server_server/r0.1.4#signing-events not https://matrix.org/docs/spec/appendices#signing-json where the latter covers the generic concept and doesn't mention content hashes
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Compare the appendices signing section at https://matrix.org/docs/spec/appendices#signing-json with the server-server signing-events section at https://matrix.org/docs/spec/server_server/r0.1.4#signing-events. Add the cross-reference or clarification so readers looking for event signing and content hashes reach the s2s specification, while preserving the generic explanation.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100