docs: update ALL docs to reflect shipped features (TypeCache, snowflake, NATS CommandBus, etc) #45

New issue

Closed

opened 2026-02-20 10:10:48 +00:00 by ash · 0 comments

ash commented

2026-02-20 10:10:48 +00:00

Owner

Problem

Docs are stale. Zero mentions of recently shipped features:

TypeCache + sync.Pool (pooled deserialization)
Snowflake ID generator
NATS distributed CommandBus (natscommand/)
NATS atomic batch (natsbatch/)
NATS notifier (natsnotifier/)
Stream existence hints (WithHint)
TodoList automation pattern
Scale benchmarks (49k cmd/s)
Postgres clustering
SQLite notifier
StoreAdapter
Conformance e2e suite

Must update:

README.md — feature list, quick examples
docs/quickstart.md — mention CommandBus, stream hints
docs/architecture.md — NATS distributed bus, TodoList pattern
docs/performance.md — scale numbers, TypeCache benchmarks, comparison results
docs/event-modeling.md — TodoList for automations
docs/operations.md — NATS clustering ops
docs/testing.md — conformance e2e suite
All examples must demonstrate new features where relevant

## Problem Docs are stale. Zero mentions of recently shipped features: - TypeCache + sync.Pool (pooled deserialization) - Snowflake ID generator - NATS distributed CommandBus (natscommand/) - NATS atomic batch (natsbatch/) - NATS notifier (natsnotifier/) - Stream existence hints (WithHint) - TodoList automation pattern - Scale benchmarks (49k cmd/s) - Postgres clustering - SQLite notifier - StoreAdapter - Conformance e2e suite ## Must update: - README.md — feature list, quick examples - docs/quickstart.md — mention CommandBus, stream hints - docs/architecture.md — NATS distributed bus, TodoList pattern - docs/performance.md — scale numbers, TypeCache benchmarks, comparison results - docs/event-modeling.md — TodoList for automations - docs/operations.md — NATS clustering ops - docs/testing.md — conformance e2e suite - All examples must demonstrate new features where relevant