matrix-org / matrix-org/rust-synapse-compress-state
Document whether the compressor can run in parallel to synapse
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 173
- Forks
- 37
- PR merge metrics
- No merged PRs in 30d
Description
Is your feature request related to a problem? Please describe.
We should document whether it is safe to run the compressor in parallel to synapse.
Describe the solution you'd like
A clear and concise description of whether or not the compressor and synapse are designed to work in parallel.
Describe alternatives you've considered
To document that it is not possible.
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
Start by reviewing the compressor's repository documentation and implementation alongside Synapse's relevant state-management guidance; no specific file or test is identified in the issue. Determine whether running compression concurrently with Synapse is supported, then document the conclusion and any limitations clearly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100