tursodatabase/libsql

Document replication indexes in the remote protocol

Open

#797 opened on Dec 18, 2023

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)C (490 forks)batch import
documentationenhancementhelp wanted

Repository metrics

Stars
 (16,744 stars)
PR merge metrics
 (PR metrics pending)

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

Research direction
Locate the documentation files for the remote protocol (likely in docs/ or similar) and add descriptions for the replication index fields found in src/hrana/proto.rs.
Tech stack
rust
Domain
backenddatabase
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85