Skip to content

Commit e54b113

Browse files
committed
docs: restructure docs to resolve #14 and #11
Replace flat numbered layout with structured guides/modules layout: - docs/README.md — index with module/guide/diagram tables - docs/getting-started.md — quickstart (in-process, WebSocket, stdio) - docs/architecture.md — wire format, message taxonomy, sessions, jobs, leases, threading, Jackson config - docs/transports.md — all transport adapters documented - docs/conformance.md — spec §§ coverage table and known gaps - docs/troubleshooting.md — all 15 error codes with causes and fixes - docs/recipes.md — idempotent retry, streaming, OTel, budgets, delegation, resume, vendor extensions - docs/guides/ — 11 topic guides (sessions, auth, jobs, job-events, leases, credentials, delegation, observability, resume, errors, vendor-extensions) - docs/modules/ — 10 module reference pages Delete 14 old numbered/flat docs files (00-overview.md, 02-concepts.md, 03-features/*, 05-reference/*). Closes #14, closes #11
1 parent 6ab0edb commit e54b113

44 files changed

Lines changed: 3453 additions & 1041 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/00-overview.md

Lines changed: 0 additions & 38 deletions
This file was deleted.

docs/02-concepts.md

Lines changed: 0 additions & 125 deletions
This file was deleted.

docs/03-features/ack.md

Lines changed: 0 additions & 45 deletions
This file was deleted.

docs/03-features/agent-versions.md

Lines changed: 0 additions & 62 deletions
This file was deleted.

docs/03-features/cost-budget.md

Lines changed: 0 additions & 64 deletions
This file was deleted.

docs/03-features/heartbeats.md

Lines changed: 0 additions & 57 deletions
This file was deleted.

0 commit comments

Comments
 (0)