matrix-org / matrix-org/seshat
Expose the Indexer publicly.
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 127
- Forks
- 29
- Avg merge
- 22h 40m
- Merged PRs (30d)
- 3
Description
Some clients might already have an event store yet they might want to index events as well. One of those clients is for example Riot-X on Android.
Such clients will want to use only the indexing side of Seshat. Luckily the implementation already has a clear separation of the database and the indexer.
For this to be fixed the Index struct will need to be made public, documenting all the public methods will be necessary as well.
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 locating the existing private Index struct and its methods in the Rust indexer implementation. Make the intended indexing API public, document each public method, and verify that the crate still builds and exposes the API for external clients.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- search
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100