matrix-org / matrix-org/matrix.org
e2ee guide gives incorrect advice on how to deal with Olm session conflicts
Open
Nobody has claimed this yet.
guides
- Dominant language
- JavaScript
- Stars
- 616
- Forks
- 463
- Avg merge
- 2d 3h
- Merged PRs (30d)
- 19
Description
Guide says in point 2 to order session IDs by ASCII, but the spec wants to use the last successful session.
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
Open the linked end-to-end encryption implementation guide and read the “Encrypting an event with Olm” section, especially point 2. Compare its session-conflict advice with the specification, then update the guide to describe using the last successful session and verify that the published wording no longer recommends ASCII ordering.
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
- 45/100