tursodatabase / tursodatabase/libsql
Document replication indexes in the remote protocol
Open
Nobody has claimed this yet.
documentation
enhancement
help wanted
- Dominant language
- C
- Stars
- 17.2k
- Forks
- 531
- Avg merge
- 1h 12m
- Merged PRs (30d)
- 1
Description
There's support for specifying replication index in the remote protocol, but it's currently not documented:
https://github.com/tursodatabase/libsql/blob/main/libsql-server/src/hrana/proto.rs#L16-L35
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 reading the replication-index definitions and comments in libsql-server/src/hrana/proto.rs#L16-L35, then locate the remote protocol documentation that should describe them. Document the supported replication-index behavior and confirm that the documentation matches the protocol definitions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100