Skip to content

docs: polish the factory infrastructure and self-hosting pages (audit 5/5) - #857

Draft
hongyi-chen wants to merge 9 commits into
mainfrom
oz/factories-audit-infrastructure
Draft

hongyi-chen wants to merge 9 commits into
mainfrom
oz/factories-audit-infrastructure

Conversation

@hongyi-chen

Copy link
Copy Markdown
Collaborator

Summary

Part 5 of 5 of the Warp Factories docs audit (split out of #852). The infrastructure cluster plus the leftovers that didn't belong to another part: the quickstart, troubleshooting, the definition page's label, and the sidebar. The self-hosting changes are almost entirely mechanical.

Changes

infrastructure-and-security.mdx

  • The opening section is "What runs where" instead of "Control plane and execution plane": it says what Warp does and the two places code runs, in the reader's terms, and the diagram's Warp node drops the control-plane label. The style guide names control planes as the example of architecture the reader can't act on.
  • Double blank line removed; Related pages use plain links.

warp-hosting.mdx

  • "compatible with any Linux x86-64 image" contradicted runners.mdx (aarch64 and macOS runners exist); the sentence now matches the runners page and links to it.
  • "fully-isolated sandboxes... to ensure reliable sandbox startup" and the future-tense concurrency sentence are plainer; a stray --- is gone. The IP list is untouched.

deployment-patterns.mdx and runners.mdx

  • The integrations list includes Microsoft Teams and Azure DevOps; the "What it looks like" bullets capitalize consistently.
  • runners.mdx: en dashes in lists become the hyphen the rest of the section uses; "file-managed" becomes "GitHub-backed"; one unspaced em dash fixed.

self-hosting/* (10 pages)

  • Mechanical: --- separators removed (54 of them), em and en dashes in list items normalized to - (170 lines), bold-wrapped list links made plain. Four sentences reworded in the quickstart, Docker, and Direct intros ("the default and fastest path", a rhetorical question in a callout, "something like X / Y"). No technical content changed.

Leftovers

  • quickstart.mdx: "the Implement agent" lowercased; "Available team usage" becomes "Team credits"; Next steps follow the quickstart shape (recap line, plain links).
  • troubleshooting.mdx: the framing line "Each entry below names the symptom you'd see" is cut; plain link style.
  • factory-as-code.mdx: frontmatter label matches the sidebar.ts label that actually renders ("Definitions as code"); Related pages use plain links and the renamed GitHub page title. The reference body is untouched.
  • sidebar.ts: "How Factories work" becomes "How factories work" (mid-phrase "Factories" alone isn't the product name per the terminology rule).

Content design plan

Audience and JTBD: Platform and security engineers deciding where factory work runs, and anyone following the quickstart.

Problem: One contradiction between hosting pages, an architecture-first opening, and inconsistent formatting across the self-hosting cluster.

Goals: Hosting claims agree across pages; the cluster uses the same list and separator conventions as the rest of the section.

Content type: Existing conceptual, feature, reference, and quickstart pages; no new pages.

Unverified claims

None.

Documentation risk

Risk: engineering-review-required
Rationale: One platform-support sentence on warp-hosting.mdx now matches runners.mdx (aarch64 Linux images and macOS runners); the rest is wording, formatting, and labels.
Engineering review status: pending
Docs override: none

Validation

npm run build, check_links.py --internal-only (0 broken), and style_lint.py were run on the combined audit branch that these files were split from.

Plans:

Co-Authored-By: Warp agent@warp.dev

hongyi-chen and others added 9 commits October 6, 2026 15:08
Reshape the factories overview from a launch-post structure into a
technical overview: a concrete definition up front, one short section
per part of a factory, sizing guidance, and related pages. Removes the
"Who benefits", "What you get", product-table, and "Key terms" sections
and the undefined "delivery policy" coinage. The #sizing-a-factory
anchor that three pages link to is preserved.

Aligns the opening definition on how-factories-work and the docs
homepage with the overview, trims the diagram legend, cuts the salesy
self-improvement framing, and adds the missing Related pages section.

Co-Authored-By: Warp <agent@warp.dev>
Co-Authored-By: Oz <oz-agent@warp.dev>
…w-copy

# Conflicts:
#	src/content/docs/factories/how-factories-work.mdx
#	src/content/docs/factories/index.mdx
#	src/content/docs/index.mdx
Tighten the opening (drop "tools your team already uses"), make the
component headings parallel, say "repeated failures" consistently, and
note that benchmarks now compare harnesses as well as models and runners
per #841.

Co-Authored-By: Warp <agent@warp.dev>
Co-Authored-By: Oz <oz-agent@warp.dev>
Add Microsoft Teams and Azure DevOps to the how-factories-work work
sources legend so it matches the overview, and drop the restated
consequence clause from the overview's Execution section in favor of
naming what the infrastructure page covers.

Co-Authored-By: Warp <agent@warp.dev>
Co-Authored-By: Oz <oz-agent@warp.dev>
Same treatment as the factories overview: a concrete opener, three
short lists of what Enterprise adds (administration, security and
compliance, shared team configuration), role-based entry points, and
related pages. Removes the "Who Warp Enterprise is for", "What this
section covers", "Why enterprises choose Warp", and "Support and
resources" sections and the marketing adjectives. Every retained claim
was checked against the enterprise page it links to.

Co-Authored-By: Warp <agent@warp.dev>
Co-Authored-By: Oz <oz-agent@warp.dev>
Shorten the lead to two sentences, keep the CTA cards directly under it,
and open a "What a factory does" section for the foreman, example, and
human-checkpoint detail so the body is not an unbroken block of prose
before the first H2. Rewrite the description so it stops repeating the
lead paragraph it renders next to.

Co-Authored-By: Warp <agent@warp.dev>
Co-Authored-By: Oz <oz-agent@warp.dev>
Part 5 of 5 of the Warp Factories docs audit, split out of #852.

Co-Authored-By: Warp <agent@warp.dev>
@hongyi-chen hongyi-chen added the warpy-factory Opened by the Warp factory agents label Oct 7, 2026 — with Warp Agent Staging

Copy link
Copy Markdown
Collaborator Author

This PR was generated with Warp.

Comment @warp-agent on this PR to send it follow-up work.

View run View conversation

@cla-bot cla-bot Bot added the cla-signed label Oct 7, 2026
@vercel

vercel Bot commented Oct 7, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
docs Ready Ready Preview Oct 7, 2026 12:06am UTC

Request Review

Base automatically changed from hyc/factories-overview-copy to main October 7, 2026 00:14

This branch was successfully deployed

1 active deployment
Preview — 9f5ab94b Deployed Oct 7, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cla-signed warpy-factory Opened by the Warp factory agents

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant