docs: comprehensive documentation overhaul #350

Merged

jwilger-ai-bot merged 8 commits from docs/documentation-overhaul into main

2026-04-11 17:22:27 -07:00

jwilger-ai-bot commented

2026-04-11 17:16:16 -07:00

(Migrated from github.com)

Summary

Remove stale files: root CHANGELOG.md (per-crate changelogs are auto-generated by release-plz), docs/PLANNING.md (referenced deprecated dot CLI), and docs/examples/ directory (175KB of code using the old CommandExecutor API)
Fix all eventsourcing/eventcore GitHub org references to jwilger/eventcore in CONTRIBUTING.md, SECURITY.md
Update ARCHITECTURE.md references in CLAUDE.md and AGENTS.md to point to docs/manual/01-introduction/04-architecture.md (the old file didn't exist)
Rewrite README.md Quick Start with current API (execute() free function, sync apply/handle, Event trait with stream_id()/event_type_name())
Rewrite CONTRIBUTING.md: Conventional Commits, cargo nextest run, correct clippy/fmt flags, remove dot CLI references, add SQLite/testing/mutants/hooks info
Update SECURITY.md supported versions from 0.1.x to 0.6.x
Add ADRs 035 and 036 to the ADR index
Fix docs/manual/README.md table of contents (wrong directory paths, missing Security/Operations parts)
Audit and fix all 46 manual files for stale API patterns: CommandExecutor, StoredEvent, #[async_trait], mutable apply, async handle, CommandResult, ReadStreams, StreamWrite
Close 7 resolved GitHub issues (#245, #276, #300, #302, #324, #325, #327) that had merged PRs but weren't auto-closed

53 files changed, 1,322 insertions, 7,489 deletions.

Test plan

cargo build --workspace passes
cargo clippy --all-targets --all-features -- -D warnings passes
cargo fmt --all -- --check passes
All pre-commit hooks pass on every commit
Grep for stale patterns (StoredEvent, CommandExecutor, async_trait, eventsourcing/eventcore) returns no false positives
Manual spot-check of README Quick Start example against actual API
Verify manual chapter links resolve correctly

🤖 Generated with Claude Code

## Summary - Remove stale files: root `CHANGELOG.md` (per-crate changelogs are auto-generated by release-plz), `docs/PLANNING.md` (referenced deprecated `dot` CLI), and `docs/examples/` directory (175KB of code using the old `CommandExecutor` API) - Fix all `eventsourcing/eventcore` GitHub org references to `jwilger/eventcore` in CONTRIBUTING.md, SECURITY.md - Update ARCHITECTURE.md references in CLAUDE.md and AGENTS.md to point to `docs/manual/01-introduction/04-architecture.md` (the old file didn't exist) - Rewrite README.md Quick Start with current API (`execute()` free function, sync apply/handle, `Event` trait with `stream_id()`/`event_type_name()`) - Rewrite CONTRIBUTING.md: Conventional Commits, `cargo nextest run`, correct clippy/fmt flags, remove `dot` CLI references, add SQLite/testing/mutants/hooks info - Update SECURITY.md supported versions from 0.1.x to 0.6.x - Add ADRs 035 and 036 to the ADR index - Fix docs/manual/README.md table of contents (wrong directory paths, missing Security/Operations parts) - Audit and fix all 46 manual files for stale API patterns: `CommandExecutor`, `StoredEvent`, `#[async_trait]`, mutable `apply`, async `handle`, `CommandResult`, `ReadStreams`, `StreamWrite` - Close 7 resolved GitHub issues (#245, #276, #300, #302, #324, #325, #327) that had merged PRs but weren't auto-closed 53 files changed, 1,322 insertions, 7,489 deletions. ## Test plan - [x] `cargo build --workspace` passes - [x] `cargo clippy --all-targets --all-features -- -D warnings` passes - [x] `cargo fmt --all -- --check` passes - [x] All pre-commit hooks pass on every commit - [x] Grep for stale patterns (`StoredEvent`, `CommandExecutor`, `async_trait`, `eventsourcing/eventcore`) returns no false positives - [ ] Manual spot-check of README Quick Start example against actual API - [ ] Verify manual chapter links resolve correctly 🤖 Generated with [Claude Code](https://claude.com/claude-code)

jwilger (Migrated from github.com) approved these changes

2026-04-11 17:22:23 -07:00