From 281beb952826da3385e4e357c67b52290a15b3f0 Mon Sep 17 00:00:00 2001 From: Bryan Helmkamp Date: Tue, 10 Mar 2026 00:29:47 -0400 Subject: [PATCH] Simplify quick start to standalone mode and add server deployment stub Remove API server and web frontend instructions from quick start, replacing them with a note about standalone vs. server mode. Add under-development warning to API overview. Add server deployment stub page to Guides. Co-Authored-By: Claude Opus 4.6 --- docs/administration/deploy-server.mdx | 8 +++++++ docs/api-reference/overview.mdx | 4 ++++ docs/docs.json | 1 + docs/getting-started/quick-start.mdx | 30 +++++++-------------------- 4 files changed, 20 insertions(+), 23 deletions(-) create mode 100644 docs/administration/deploy-server.mdx diff --git a/docs/administration/deploy-server.mdx b/docs/administration/deploy-server.mdx new file mode 100644 index 000000000..4e93fa186 --- /dev/null +++ b/docs/administration/deploy-server.mdx @@ -0,0 +1,8 @@ +--- +title: "Server Deployment" +description: "Deploy the Arc server to production" +--- + + +This guide is coming soon. Deployment guides are currently in development. + diff --git a/docs/api-reference/overview.mdx b/docs/api-reference/overview.mdx index 053750cdf..7a516277d 100644 --- a/docs/api-reference/overview.mdx +++ b/docs/api-reference/overview.mdx @@ -3,6 +3,10 @@ title: "API Overview" description: "Introduction to the Arc REST API" --- + +The Arc API is **under active development** and may be subject to change. Endpoints, request/response formats, and authentication mechanisms may evolve as the project matures. + + The Arc API is a REST API for managing workflow runs, interactive sessions, and related resources. All requests and responses use JSON. ## Base URL diff --git a/docs/docs.json b/docs/docs.json index b105cb68d..255c8937f 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -150,6 +150,7 @@ "group": "Deployment", "icon": "server", "pages": [ + "administration/deploy-server", "administration/deploy-railway", "administration/deploy-render", "administration/deploy-fly-io", diff --git a/docs/getting-started/quick-start.mdx b/docs/getting-started/quick-start.mdx index 6e4b10502..73b9038e7 100644 --- a/docs/getting-started/quick-start.mdx +++ b/docs/getting-started/quick-start.mdx @@ -10,7 +10,6 @@ description: "Get up and running with Arc" ## Prerequisites - [Rust](https://rustup.rs/) (latest stable) -- [Bun](https://bun.sh/) (for the web frontend) - At least one LLM API key (e.g. `ANTHROPIC_API_KEY`, `OPENAI_API_KEY`, or `GEMINI_API_KEY`) ## Clone and build @@ -32,9 +31,9 @@ cp .env.example .env Edit `.env` and add at least one LLM provider key: ```bash -export ANTHROPIC_API_KEY=sk-ant-... -export OPENAI_API_KEY=sk-... -export GEMINI_API_KEY=AI... +ANTHROPIC_API_KEY=sk-ant-... +OPENAI_API_KEY=sk-... +GEMINI_API_KEY=AI... ``` @@ -71,27 +70,12 @@ Or a multi-step plan-approve-implement workflow with a human approval gate: ./target/release/arc run docs-internal/demo/10-plan-implement.dot ``` -## Start the API server +## Standalone vs. Server mode -The API server exposes a REST API for launching and managing workflow runs: +Arc has two modes: -```bash -./target/release/arc serve -``` - -This starts the server on `http://localhost:3000`. Demo mode is per-request — the web UI sends the `X-Arc-Demo: 1` header automatically when configured with `ARC_DEMO=1`. - -## Start the web frontend - -In a separate terminal, install dependencies and start the React dev server: - -```bash -cd apps/arc-web -bun install -bun run dev -``` - -The web UI is available at `http://localhost:5173` and connects to the API server on port 3000. +- **Standalone mode** — Run workflows directly from the CLI. This is what the quick start covers above. +- **Server mode** — A REST API server with a web frontend for launching and managing workflow runs. See [Server Deployment](/administration/deploy-server) for details. ## Next steps