docs: add software factory concept page and 5 guides#236
Conversation
Add a conceptual anchor page explaining the software factory model and five practical guides covering each stage of the loop: - agent-platform/cloud-agents/software-factory.mdx: What is a software factory? Introduces the inner/outer loop framework, the four agent roles (triage, spec, implement, review), and oz-for-oss as the canonical reference implementation. - guides/agent-workflows/build-a-triage-agent.mdx - guides/agent-workflows/write-product-and-tech-specs-with-agents.mdx - guides/agent-workflows/chain-a-software-factory.mdx - guides/agent-workflows/run-a-software-factory-in-the-cloud.mdx - guides/agent-workflows/build-a-self-improving-agent.mdx Sidebar: adds 'Software factory' under Oz Cloud Agents & Orchestration and a new 'Build a software factory' section in the Guides sidebar. Key sources: warpdotdev/oz-for-oss (reference implementation), warpdotdev/common-skills (spec skills), ZL X/Twitter articles on self-improvement loops and spec-driven development, Rectangle Health Rex case study. Co-Authored-By: Oz <oz-agent@warp.dev>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
I'm starting a first review of this pull request. You can view the conversation on Warp. I completed the review and no human review was requested for this pull request. Comment Powered by Oz |
There was a problem hiding this comment.
Overview
This PR adds a software factory concept page and five related guides for triage, specs, chaining, cloud operation, and self-improvement. The structure and internal links are broadly coherent, and the attached spec context contains no approved spec to validate against.
Concerns
- Several copied workflow examples configure
warpdotdev/oz-agent-actiondifferently from the existing GitHub Actions docs by puttingWARP_API_KEYinenvinstead of passingwarp_api_keyas an action input. - The new workflow examples omit explicit GitHub token permissions even though the documented agents need to label issues, post comments, create branches, open PRs, or review PRs.
- One reviewer workflow uses the PR number to locate specs even though the implementation workflow writes specs under the issue number.
- One cloud setup command documents an unsupported/undocumented environment CLI shape, and one secrets command both uses the wrong secrets syntax and encourages passing a token value on the command line.
- A few slash-command code fences are missing language identifiers.
Security
- The
oz secret create --name GITHUB_TOKEN --value YOUR_TOKENexample would put real token material in shell history and process arguments. The docs should use the interactive or value-file secret flow instead.
Verdict
Found: 3 critical, 3 important, 1 suggestion
Request changes
Comment /oz-review on this pull request to retrigger a review (up to 3 times on the same pull request).
Powered by Oz
| environment: YOUR_OZ_ENVIRONMENT_SLUG | ||
| env: | ||
| WARP_API_KEY: ${{ secrets.WARP_API_KEY }} | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} |
There was a problem hiding this comment.
🚨 [CRITICAL] The action docs configure warp_api_key as a with: input, not an environment variable, so this copied workflow may fail authentication. Keep GITHUB_TOKEN in env if needed, but pass the Warp API key through the action input.
| environment: YOUR_OZ_ENVIRONMENT_SLUG | |
| env: | |
| WARP_API_KEY: ${{ secrets.WARP_API_KEY }} | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| environment: YOUR_OZ_ENVIRONMENT_SLUG | |
| warp_api_key: ${{ secrets.WARP_API_KEY }} | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} |
| issues: | ||
| types: [opened] | ||
|
|
||
| jobs: |
There was a problem hiding this comment.
issues: write. Repositories with read-only default workflow permissions will fail; add an explicit permissions block before jobs:.
| issues: | ||
| types: [labeled] | ||
|
|
||
| jobs: |
There was a problem hiding this comment.
permissions blocks to each example so copied workflows work under restricted repository defaults.
…re-factory, warp-hosting Align three entries to 6-tab depth matching all other items in the Oz Cloud Agents & Orchestration items array. Co-Authored-By: Oz <oz-agent@warp.dev>
- build-a-triage-agent: add permissions block, move warp_api_key to with: - chain-a-software-factory: add role-specific permissions blocks to all three workflows, move warp_api_key to with:, fix reviewer prompt to search changed specs/ files instead of using PR number - write-product-and-tech-specs: add bash language to slash-command fences - run-a-software-factory-in-the-cloud: fix oz environment create syntax (owner/repo format, remove unsupported --branch flag), fix oz secret create to not expose --value on command line Also adds Oz CLI + GitHub Actions guardrails to draft_guide/SKILL.md to prevent these classes of error in future guide drafts. Co-Authored-By: Oz <oz-agent@warp.dev>
What
Adds a conceptual anchor page and five practical guides covering the software factory model — a system where specialized agents handle the full development loop from issue to PR.
New pages
Concept page (Agents sidebar → Oz Cloud Agents & Orchestration):
agent-platform/cloud-agents/software-factory.mdx— What is a software factory? Introduces the inner/outer loop framework, the four agent roles (triage, spec, implement, review), andwarpdotdev/oz-for-ossas the canonical reference implementation.Guides (new "Build a software factory" Guides sidebar section):
guides/agent-workflows/build-a-triage-agent.mdxguides/agent-workflows/write-product-and-tech-specs-with-agents.mdxguides/agent-workflows/chain-a-software-factory.mdxguides/agent-workflows/run-a-software-factory-in-the-cloud.mdxguides/agent-workflows/build-a-self-improving-agent.mdxSkill update:
.agents/skills/draft_guide/SKILL.md— New "Oz CLI and GitHub Actions accuracy" section with guardrails foroz-agent-actioninput format, permissions blocks, Oz CLI verification,oz secret createsecurity, and slash-command code fence convention.Why
Turns ZL's X/Twitter articles and Warp blog posts on software factories into actionable, Warp/Oz-native documentation. A reader — or an AI engine answering "how do I build cloud agents that execute a software factory" — should clearly land on Oz/Warp as the solution.
Review notes
software-factory.mdx) first — all 5 guides link back to itChanges since initial push (addressing oz-for-oss bot review)
deployment-patterns,software-factory, andwarp-hostingto 6-tab depth matching the rest of the Oz Cloud Agents items arrayoz-agent-actioninput format — MovedWARP_API_KEYfromenv:towarp_api_key:underwith:in all four GitHub Actions workflow examples (triage, spec, implementation, reviewer)permissions:blocks — Added role-specific permissions to every workflow:issues: writefor triage;contents: write+pull-requests: writefor spec/implementation;pull-requests: writefor reviewerspecs/*/PRODUCT.mdandspecs/*/TECH.mdfiles rather than using the PR number (which often differs from the issue number that specs were written under)oz environment createsyntax — Corrected toowner/repoformat; removed unsupported--branchflagoz secret createsecurity — Removed--valueflag (exposes secrets in shell history); CLI now prompts interactivelybashto the three slash-command fences (/write-product-spec,/write-tech-spec,/validate-changes-match-specs) per style guideKey sources
warpdotdev/oz-for-oss— deployable software factory (reference for all guides)warpdotdev/common-skills— spec skills (write-product-spec,write-tech-spec,validate-changes-match-specs)Validation
npm run build— 345 pages ✓npm run typecheck— 0 errors ✓Conversation: https://staging.warp.dev/conversation/1a4548e0-e8be-4016-bbc4-687462faba8b
Plan: https://staging.warp.dev/drive/notebook/LD1WUNi1YdAdPmNuKvU6mX
Co-Authored-By: Oz oz-agent@warp.dev