Skip to content

docs: reposition README as a standalone KV store; benchmarks, changelog, progress catch-up - #87

Merged
qdequele merged 1 commit into
mainfrom
qdequele/docs-readme-reposition
Oct 1, 2026
Merged

qdequele merged 1 commit into
mainfrom
qdequele/docs-readme-reposition

Conversation

@qdequele

@qdequele qdequele commented Oct 1, 2026

Copy link
Copy Markdown
Owner

Documentation-only, plus one crate-doc example (verified compiling).

  • README repositioned as a pure-Rust, LMDB-design KV store (standalone + heed drop-in), simplified to essentials, with a usage example; cross-engine throughput table (NVMe Graviton public suite) + read-side context; removes the non-existent v0.1.0 tag from the install snippets.
  • benches/results/2026-09-30-public-suite-nvme.md (new): full per-engine tables (throughput, latency, RSS, disk) backing the README table.
  • CHANGELOG [Unreleased]: the post-0.1.0 perf campaign + ADR-0014/0015/0017/0018 + dependency refresh.
  • PROGRESS.md: backfill 2026-09-25 → 10-01 (campaign, cross-engine suite, ADR-0018 amendment merged, ADR-0019 parked, ADR-0020 spike).
  • crates/zerodb/src/lib.rs: refresh the stale module doc + add a compiling no_run example.

No engine code changes.

🤖 Generated with Claude Code

…og, progress catch-up

- README: present ZeroDB as a pure-Rust LMDB-design KV store (standalone + heed
  drop-in), simplified to the essentials, with a usage example; cross-engine
  throughput table (NVMe Graviton public suite) and the LMDB campaign link.
  Drop the non-existent v0.1.0 tag from the install snippets.
- benches/results/2026-09-30-public-suite-nvme.md: full per-engine tables
  (throughput, latency, RSS, disk) backing the README table.
- CHANGELOG [Unreleased]: the post-0.1.0 perf campaign + ADR-0014/15/17/18 + deps.
- PROGRESS.md: backfill 2026-09-25..10-01 (campaign, cross-engine suite, ADR-0018
  amendment merged, ADR-0019 parked, ADR-0020 spike).
- crates/zerodb/src/lib.rs: refresh the stale module doc + add a compiling example.
@qdequele
qdequele merged commit 84582e8 into main Oct 1, 2026
9 of 10 checks passed
@coderabbitai

coderabbitai Bot commented Oct 1, 2026

Copy link
Copy Markdown

Review in Change Stack →

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

Note

Currently processing new changes in this PR. This may take a few minutes, please wait...

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: dff1654e-74f5-4ca1-8655-9bd8bf65cd9c

📥 Commits

Reviewing files that changed from the base of the PR and between 2a69c79 and 79ca3d7.

📒 Files selected for processing (5)
  • CHANGELOG.md
  • PROGRESS.md
  • README.md
  • benches/results/2026-09-30-public-suite-nvme.md
  • crates/zerodb/src/lib.rs
 _______________________________
< BOFH: Bunny of Friendly Help. >
 -------------------------------
  \
   \   \
        \ /\
        ( )
      .( o ).
✨ Finishing Touches
📝 Generate docstrings
  • Commit to this branch
  • Create a new PR
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Autopilot is currently an internal CodeRabbit preview.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@qdequele
qdequele deleted the qdequele/docs-readme-reposition branch October 1, 2026 22:27
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