Tags: ja7ad/slate
Tags
docs: add per-module READMEs and per-crate manifest metadata; bump to…
… 0.3.5
Every module now ships its own README: crates/slate-kv{,-core,-hal,-crypto,
-erasure,-ffi,-sim,-cli}, targets/esp32 and fuzz. Each covers what the module
is, where it sits in the dependency graph, install/build, a worked usage
example, its API surface, the invariants a caller must uphold, and its
report references.
This reverses fix/crates-readme: `readme.workspace = true` resolved to
../../README.md for every crate, so all six published crates would render the
identical root README and the identical generic description on crates.io. Each
manifest now sets `readme = "README.md"` plus its own description, keywords,
categories and documentation; the workspace keeps only version, edition,
license, repository and homepage.
Also:
- publish = false on slate-kv-ffi, slate-kv-sim and slate-esp32 — build
artifacts and a dev harness, none of which the release workflow publishes
- [package.metadata.docs.rs] all-features on slate-kv-core so the `metrics`
feature is documented
- manifest metadata for slate-esp32 and slate-fuzz, which had none
- versions bumped 0.3.3 -> 0.3.5 across the workspace, targets/esp32 and fuzz,
including inter-crate path-dependency requirements, with both Cargo.lock
files refreshed. v0.3.4 was tagged without a matching manifest bump, so
0.3.4 is skipped rather than reused.
READMEs record current stubs honestly rather than implying coverage:
repair::scrub, Db::scrub, the slate-kv-sim src/bin studies, and the empty
fuzz_marker_decode / fuzz_recover targets.
Verified: cargo fmt --check, cargo clippy --workspace --all-targets,
cargo test --workspace, and cargo package --list on each published crate.
PreviousNext