Skip to content

docs(www): add ACP and Zed guides with CLI and RPC server pages - #65

Closed
sanchitrk wants to merge 9 commits into
canaryfrom
claude/project-thread-ap4zx4
Closed

sanchitrk wants to merge 9 commits into
canaryfrom
claude/project-thread-ap4zx4

Conversation

@sanchitrk

Copy link
Copy Markdown
Contributor

Requested by Sanchit · project thread

Before: the docs covered install, quickstart and models only. Nothing explained how to use CodeWork from an editor, the CLI surface, or the RPC server.

After: a new Interfaces sidebar section with:

  • ACP → Overview (/docs/acp): what ACP is, how codework acp works as a stdio ACP server, a supported/not-supported capability table, pre-flight steps (install, credentials), and the command reference.
  • ACP → Zed (/docs/acp/zed): step-by-step agent_servers setup, API keys via env, custom --home, starting a thread, model/thinking pickers, thread history import, and troubleshooting.
  • CLI (/docs/cli): run flags, command table, global flags and env vars.
  • RPC Server (/docs/rpc): codework serve, CLI --server usage, method table from the contract, events and lifecycle, and an RPC vs ACP comparison.

Screenshots and videos are <Placeholder> boxes describing the shot to capture, to be replaced with real media later.

How: content is sourced from packages/codework/src/acp/*, src/server/contract.ts, src/cli/cmd/cmd.ts and the CLI README; Zed steps follow zed.dev's external agents docs. Adds a small Placeholder component (src/components/placeholder.tsx) registered as a global MDX component in pages/docs/[...slug].astro. vp check sites/www and the site typecheck (astro sync + astro check + tsc) pass. The CLI and RPC pages carry TODO comments where a fuller reference is planned.

🤖 Generated with Claude Code

https://claude.ai/code/session_015RsKETJs37gmy2D32n1mWs


Generated by Claude Code

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_015RsKETJs37gmy2D32n1mWs
@sanchitrk sanchitrk self-assigned this Oct 10, 2026
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_015RsKETJs37gmy2D32n1mWs
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_015RsKETJs37gmy2D32n1mWs
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_015RsKETJs37gmy2D32n1mWs
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_015RsKETJs37gmy2D32n1mWs
Split into Overview, Installation, Capabilities, ACP (with Zed setup), RPC Server and Reference under /docs/cli.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_015RsKETJs37gmy2D32n1mWs
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_015RsKETJs37gmy2D32n1mWs
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_015RsKETJs37gmy2D32n1mWs
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_015RsKETJs37gmy2D32n1mWs

Copy link
Copy Markdown
Contributor Author

Superseded by #67, which merged this content (plus screenshots) into canary.


Generated by Claude Code

@sanchitrk sanchitrk closed this Oct 11, 2026
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.

2 participants