diff --git a/src/content/docs/factories/quickstart.mdx b/src/content/docs/factories/quickstart.mdx index 13312a88..03bb3392 100644 --- a/src/content/docs/factories/quickstart.mdx +++ b/src/content/docs/factories/quickstart.mdx @@ -1,19 +1,97 @@ --- title: Warp Factories quickstart description: >- - Create a Warp Factory, connect a repo, and trigger your first automated - work item in a few minutes. + Set up a factory, connect GitHub, and submit your first work item in about + 10 minutes. sidebar: label: "Quickstart" --- +import { Steps } from '@astrojs/starlight/components'; +import { VARS } from '@data/vars'; -[STUB — pending content from HYC/content team for the 8/18 closed-beta soft launch. Owner: HYC. +A factory is a team of cloud agents — a foreman you talk to, plus the subagents it dispatches — that turns incoming requests into pull requests for your team to review. In this quickstart you create a factory, connect a GitHub repository, and take one small work item from prompt to pull request in about 10 minutes. -Follow the quickstart template (`.agents/templates/quickstart.md`). Cover: -1. Create a Factory -2. Connect a repo -3. Configure the default agents (triage, spec, implement, review) -4. Trigger work (e.g. via Slack, Linear, GitHub, or the Factory MCP) -5. View / interact with the run in the control room web app +## Prerequisites -Keep prerequisites minimal and link out to How Factories work / Configure your Factory / Connect your Factory for depth rather than inlining it here.] +* **A Warp team with credits** - A factory belongs to a [Warp team](/knowledge-and-collaboration/teams/), and its agents consume the team's credits. If the team has no active plan, setup asks you to select one. +* **GitHub repository access** - You authorize GitHub and choose repositories during setup. If your organization restricts app installations, ask a GitHub organization owner to approve the connection. See the [GitHub integration](/platform/integrations/github/) for details. + +## Create your factory + +_~5 minutes_ + + + +1. #### Start a new factory + + Open the {VARS.FACTORY_WEB_APP} at platform.warp.dev and sign in. In the sidebar, click **+** next to **Factories** to open the setup wizard. + + If your account has no team yet, the wizard first asks you to choose the team that will own the factory. When that team has no plan or credits, it opens **Select a Warp Plan**: a factory needs credits to run its agents. + +2. #### Connect GitHub and select your repos + + Click **I want to use repos from GitHub** and complete the GitHub authorization. Then choose the repositories the factory will work in and click **Add repos**. + + Start with one or two repositories: every agent in the factory shares this repo set, so a focused set keeps their context tight. Warp provisions a default [environment](/platform/environments/) for the selected repos. + +3. #### Name your factory + + Enter a **Factory name**, such as `Payments services`. Warp derives a matching **Factory alias**, the handle teammates use to @-mention the factory from connected tools like Slack and Linear. Keep it short and recognizable. + + The next screen offers to connect Slack. This quickstart skips integrations, so click **Next**. You can connect them any time from [Connect your factory](/factories/connect-your-factory/). + +4. #### Choose your agents and create the factory + + The foreman leads every factory: it is the orchestration agent you interact with directly. Below it, toggle the subagents it can dispatch: **Triage**, **Spec**, **Code**, and **Review**. All four start enabled, and at least one is required. Keep **Code** on so this quickstart's work item can end in a pull request. See [Factory agents](/factories/factory-agents/) for what each role does. + + Skip the issue tracker screen the same way as Slack: click **Next**, and Warp creates the factory. When the startup screen reports **Factory running!**, click **Go to dashboard**. + + + +## Submit your first work item + +_~5 minutes_ + + + +1. #### Start a run + + In the sidebar under your factory, open **Runs** and click **New**. Describe one small, verifiable change and submit it: + + ```text title="Example first request" + Add a "Local development" section to README.md that summarizes the setup + steps from CONTRIBUTING.md. Keep the change to that one file, run the + repo's lint check, and open a pull request. + ``` + + Adapt the pattern to your repository: name the file, the change you expect, and the command that verifies it. A narrow, explicit request makes the first run easy to judge. + + The foreman picks up the request as a run on **Runs** and dispatches your subagents as child runs. + +2. #### Watch the run and review the pull request + + Follow progress from two pages in your factory's sidebar: + + * **Runs** - The foreman's run and the child runs it dispatches. + * **Activity** - The work item as it moves through its stages. Open it to see its event history and pull request artifacts. + + When the Code agent finishes, the work item links a pull request in GitHub. Review and merge it through your normal process: the factory drafts the change, and your team makes the call. + + + +## Next steps + +* [**Connect your factory**](/factories/connect-your-factory/) - Route work in from Slack threads, Linear issues, and other intake paths. +* [**Factory MCP**](/factories/factory-mcp/) - Send work to the factory from a coding agent or MCP client. +* [**How Warp Factories work**](/factories/how-factories-work/) - The work-item lifecycle and where people stay in the loop. + +## Troubleshooting + +**A GitHub repository doesn't appear in the picker**\ +The GitHub installation doesn't cover it. Confirm the installation includes the repository and the intended organization, or ask a GitHub organization owner or Warp team admin to update the connection. + +**Factory creation stops at an agent limit**\ +Your team's plan limits how many factory agents it can run. Ask a team admin to confirm the team's capacity, or contact Warp. + +**You need to stop a run**\ +Open **Activity**, select the work item, and click **Stop task** to stop its active run.