docs(v3): refresh docs for daemon-first architecture#35
Open
Codename-11 wants to merge 1 commit into
Open
Conversation
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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs/architecture.md,docs/daemon.md,docs/protocol.md, anddocs/v2-to-v3-migration.md. Each links back todocs/plans/arc-v3-daemon.mdas the source of truth.arc daemon start,ARC_PORT, andARC_DIR. Adds a v2 deprecation notice at the bottom and updates the ToC (docs/index.md) with the new v3 section.1.0.0-alpha.0entry toCHANGELOG.mdin Keep-a-Changelog format (Added / Changed / Breaking / Removed) covering the daemon skeleton, binary-mux WS protocol, client SDK, relay placeholder, andarc daemonCLI group.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 ofuser-docs/)docs/plans/arc-v3-daemon.md, cross-refs between the four new docs, package source links).packages/daemon/src/,packages/client/src/protocol.ts,packages/cli/src/commands/daemon.ts).bad_request; auto-probe for daemon health) softened to match reality.🤖 Generated with Claude Code