Add proper documentation for the project

[pathscale]

Background

Current code is not covered with docs at all. Also there are no proper README.md with usage docs and examples.

Problem to solve

• Cover code with docs.
  • Cover codegen crate.
  • Cover table crate.
• Add proper README.md file.

---

Migrated from pathscale/wt-dead#3. Originally opened by @Handy-caT on 2024-09-30T18:20:07Z.

[pathscale]

Valid 1.0 documentation gate, but the original scope is too broad. Acceptance for release: current README examples compile; generated table/query/persistence lifecycle APIs are documented; default concurrency and durability guarantees and limitations are explicit; docs.rs builds without broken links; beta-only backend boundaries are named. Internal codegen rustdoc coverage can continue after 1.0.

[pathscale]

cargo doc --workspace --no-deps succeeds, but cargo test --doc --workspace discovers zero doctests, so README examples are not being compile-validated. The release acceptance is still incomplete: the README does not state the observed SIGKILL/power-loss behavior or a durability matrix, and #41 remains unresolved. Keep this release-hardening issue open.

[pathscale]

PR 47 added crate docs, compiled doctests, and the durability/concurrency boundaries, but release acceptance is still incomplete. A fresh external crate with only worktable as a dependency cannot compile the README quick start because generated code directly resolves undeclared consumer dependencies including rkyv, futures, tokio, uuid, and derive_more. Keep this open until the generated paths are hygienic and an independent consumer-smoke crate validates the documented install path.