sections web

Web & Desktop

Active contributors: Sagar Narayan, Andy Taylor

Purpose

docs/web/ covers Factory's non-CLI surfaces: the desktop app, the web dashboard, agent readiness, and the cloud template / machine connection system. It's significantly smaller than the CLI tree but contains the deepest subtree in the repo (web/machine-connection/cloud-templates/).

Directory layout

docs/web/
├── agent-readiness/
│   ├── overview.mdx          # What agent readiness is, why it matters
│   └── dashboard.mdx         # Reading the readiness dashboard
├── getting-started/
│   ├── overview.mdx
│   └── quickstart.mdx
└── machine-connection/
    └── cloud-templates/
        ├── index.md(x)
        ├── installation-and-usage
        ├── setup-script
        ├── best-practices
        └── troubleshooting

Agent readiness

The "agent readiness" feature measures how prepared a codebase is for agent-driven development. The web side has:

• overview.mdx — what the metric is, why it matters
• dashboard.mdx — how to read the dashboard

The CLI counterpart is docs/cli/features/readiness-report.mdx. Both pages live in the navigation under the same "Agent Readiness" group in docs/docs.json. The API surface is docs/reference/readiness-reports-api.mdx.

The branding here was renamed in late 2025 from "autonomy maturity" to "agent readiness" — this is preserved as a :slug* redirect in docs.json.

Getting started (desktop/web)

docs/web/getting-started/overview.mdx and quickstart.mdx mirror the CLI getting-started pair for the non-CLI product. They're shorter and lean on screenshots.

Cloud templates

docs/web/machine-connection/cloud-templates/ is the deepest subtree in the docs and the densest piece of the desktop app docs:

Page	What it covers
index	What cloud templates are
installation-and-usage	Provisioning a templated cloud machine
setup-script	The setup script protocol
best-practices	Known-good patterns
troubleshooting	Failure modes and diagnostics

The "Cloud Templates" group in docs.json lives under "Platform" alongside the CLI, desktop, and droid-exec entries.

Integration points

• Cross-links into docs/cli/features/droid-computers.mdx (cloud templates often back droid computers).
• Linked from the enterprise deployment docs (docs/enterprise/network-and-deployment.mdx) when on-prem or VPC machines are in scope.

Entry points for modification

• New desktop/web flow → add a page under docs/web/<area>/ and add it to the Platform group in docs.json.
• New cloud template scenario → add a page under docs/web/machine-connection/cloud-templates/ and update the Cloud Templates group.
• Branding renames affecting the URL → add a redirects entry in docs.json (see how web/autonomy-maturity was redirected to web/agent-readiness).