scriptoriumadmin/fabro
1
0
Fork 0
mirror of https://github.com/fabro-sh/fabro.git synced 2026-09-10 22:43:37 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Simplify quick start to standalone mode and add server deployment stub

Browse source 
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 <noreply@anthropic.com>
This commit is contained in:
Bryan Helmkamp 2026-03-10 00:29:47 -04:00
parent a38f5f3995
commit 281beb9528
4 changed files with 20 additions and 23 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
docs/administration/deploy-server.mdx Normal file
View file

@ -0,0 +1,8 @@
---
title: "Server Deployment"
description: "Deploy the Arc server to production"
---
<Warning>
This guide is coming soon. Deployment guides are currently in development.
</Warning>

4
docs/api-reference/overview.mdx
View file

@ -3,6 +3,10 @@ title: "API Overview"
description: "Introduction to the Arc REST API"
---
<Warning>
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.
</Warning>
The Arc API is a REST API for managing workflow runs, interactive sessions, and related resources. All requests and responses use JSON.
## Base URL

1
docs/docs.json
View file

@ -150,6 +150,7 @@
"group": "Deployment",
"icon": "server",
"pages": [
"administration/deploy-server",
"administration/deploy-railway",
"administration/deploy-render",
"administration/deploy-fly-io",

30
docs/getting-started/quick-start.mdx
View file

@ -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...
```
<Note>
@ -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