Skip to content

docs(v3): refresh docs for daemon-first architecture#35

Open
Codename-11 wants to merge 1 commit into
feature/v3-foundationfrom
feature/v3-docs-refresh
Open

docs(v3): refresh docs for daemon-first architecture#35
Codename-11 wants to merge 1 commit into
feature/v3-foundationfrom
feature/v3-docs-refresh

Conversation

@Codename-11
Copy link
Copy Markdown
Owner

Summary

  • Adds four new v3 user-facing docs: docs/architecture.md, docs/daemon.md, docs/protocol.md, and docs/v2-to-v3-migration.md. Each links back to docs/plans/arc-v3-daemon.md as the source of truth.
  • Rewrites the Getting Started "Run ARC" section around arc daemon start, ARC_PORT, and ARC_DIR. Adds a v2 deprecation notice at the bottom and updates the ToC (docs/index.md) with the new v3 section.
  • Adds a 1.0.0-alpha.0 entry to CHANGELOG.md in Keep-a-Changelog format (Added / Changed / Breaking / Removed) covering the daemon skeleton, binary-mux WS protocol, client SDK, relay placeholder, and arc daemon CLI group.
  • Adds a "v3 in progress" callout and lightly refreshes the opening section of the README.md — no wholesale rewrite.

Wire-protocol content (frame diagram, envelope schema, method catalog, schemas, topics, error codes, backward-compat rules) was hand-derived from packages/client/src/protocol.ts.

Test plan

  • pnpm install (clean)
  • npx tsc --noEmit (clean — docs-only change)
  • pnpm site:build (clean)
  • pnpm build:docs (clean — VitePress build of user-docs/)
  • Every internal link in new docs resolves (docs/plans/arc-v3-daemon.md, cross-refs between the four new docs, package source links).
  • Every code snippet cross-checked against live source (packages/daemon/src/, packages/client/src/protocol.ts, packages/cli/src/commands/daemon.ts).
  • Protocol claims that diverged from the current implementation (Zod parse errors silently drop vs. returning bad_request; auto-probe for daemon health) softened to match reality.

🤖 Generated with Claude Code

Add four new v3 user-facing docs covering the daemon operator surface,
wire protocol, architecture, and v2→v3 migration. Rewrite the Getting
Started "Run ARC" section around `arc daemon start`, `ARC_PORT`, and
`ARC_DIR`. Add a CHANGELOG entry for 1.0.0-alpha.0 in Keep-a-Changelog
format, plus a "v3 in progress" callout atop the README. Every new
page links back to `docs/plans/arc-v3-daemon.md` as the source of
truth.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant