Skip to content

docs: update ember-client readme, add crates index, regenerate protos - #307

Merged
kacy merged 1 commit into
mainfrom
docs/proto-update
Feb 25, 2026
Merged

docs: update ember-client readme, add crates index, regenerate protos#307
kacy merged 1 commit into
mainfrom
docs/proto-update

Conversation

@kacy

@kacy kacy commented Feb 25, 2026

Copy link
Copy Markdown
Owner

summary

documentation catch-up for the gRPC API gap (pr #306) and client growth:

  • ember-client readme — fully rewritten to cover all 65+ commands across every group (strings, keys, lists, hashes, sets, sorted sets, server, slowlog, pub/sub), public types (ScanPage, SlowlogEntry, Message, SimResult), the full pipeline method reference, and the vector feature section
  • crates/README.md — new navigation index with a crate table (including the ember-coreemberkv-core package name note that trips people up), ascii dependency graph, cargo cheat-sheet, and makefile target reference including the proto-gen targets
  • proto regeneration — Go and Python gRPC stubs updated from the latest proto definition; all 39 new rpcs from pr feat(grpc): close api gap — 39 new rpcs #306 are now reflected in the generated code
  • ember-py Makefile fixpythonpython3 for compatibility on systems where only python3 is in $PATH

what was tested

  • make proto-go — generated clients/ember-go/proto/ember/v1/ember.pb.go and ember_grpc.pb.go cleanly
  • make proto-py — generated clients/ember-py/ember/proto/ember/v1/ember_pb2.py and ember_pb2_grpc.py cleanly, import fix applied by sed
  • cargo build -p ember-client passes (no code changes)
  • verified all method names in the readme against the actual commands.rs, pipeline.rs, and vector.rs source

- ember-client readme now covers all 65+ commands (strings, keys, lists,
  hashes, sets, sorted sets, server, slowlog, pub/sub, vector), public types
  (ScanPage, SlowlogEntry, Message, SimResult), and the full pipeline method
  reference
- new crates/README.md: crate table with package names, dependency graph,
  cargo cheat-sheet, and makefile target reference
- regenerate go and python grpc stubs from the latest proto (closes api gap
  from pr #306 — 39 new rpcs now reflected in generated code)
- fix clients/ember-py/Makefile: use python3 instead of python
@kacy
kacy merged commit 917e93c into main Feb 25, 2026
6 of 7 checks passed
@kacy
kacy deleted the docs/proto-update branch February 25, 2026 19:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant