Repository navigation
docs: audit and polish the Warp Factories docs - #852
Closed
hongyi-chen wants to merge 1 commit into
Closed
hongyi-chen wants to merge 1 commit into
hongyi-chen wants to merge 1 commit into
Conversation
Correct product claims that drifted from warp-server (built-in factory skills, default agent models, default Scorers, the Factory MCP tool list, work-source lists, hosted image support), give duplicated content one canonical home, and make the section read consistently: every page ends with Related pages, list links share one style, integration page titles use the gerund form, and definition-location terms, agent names, and link text match across pages. Co-Authored-By: Warp <agent@warp.dev>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
This was referenced Oct 7, 2026
Collaborator
Author
|
Split into five smaller PRs for review, each against
Closing this one in favor of those. |
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Editorial and accuracy pass over the whole
src/content/docs/factories/tree (43 pages touched), on top of the overview rewrite already onhyc/factories-overview-copy. The two overview pages themselves are left as HYC's review pass shaped them; everything else gets one consistent treatment: claims re-checked againstwarp-server, duplicated content given a single home, AI-draft patterns cut, and the cross-page conventions (closing sections, link style, titles, terminology) made uniform.Changes
Claims corrected against
warp-serverfactory-skills.mdx,factory-agents.mdx): the docs said every default agent gets a GitHub skill, the foreman a Slack skill, and that these "aren't files in your definition". Warp actually seedscode-quality,code-review,ui-verification, the connected code host's skill (github,gitlab, orazuredevops),slack/microsoft-teams, andlinear/jiraas files under the factory-wideskills/directory, shared by every agent including custom ones (logic/factorysource/defaults/skills.go,logic/factory_source_export.go,logic/factoryfile/path.go).factory-agents.mdx): "setup doesn't choose models for you" replaced; setup seeds a model per role (defaults/seeds.go).scorers.mdx,measure-and-improve.mdx): new factories ship with Code Quality (implement agent) plus Efficiency, Task Compliance, Procedure Compliance, and Verbosity (defaults/scorers.go). Previously undocumented.factory-mcp.mdx): addedlist_inbox,attach_integration, andstart_factory_learning(factory_mcp/server.go;factory_learningis on inconfig/prod.yaml).automations.mdx,factory-dashboard.mdx,deployment-patterns.mdx);linear.mdxno longer points code-host access at GitHub only.warp-hosting.mdxno longer claims hosted agents take only Linux x86-64 images (contradictedrunners.mdx).One home per fact
measure-and-improve.mdx;factory-dashboard.mdxsummarizes and links.read_skillattribution guidance live onapi-and-sdk/index.mdx;factory-skills.mdxlinks.factory-skills.mdx;factory-agents.mdxcarries a two-sentence summary.Structure and tone
## Related pages(added toconnect-your-factory,factory-agents,github,gitlab,jira,linear,slack,api-and-sdk/index, the Sentry demo); list links use one plain[Title](link) - descriptionstyle throughout.factory-agents.mdx: therun_agents/agent_identity_uidsection is rewritten for a human reader; the automations paragraph gets its own heading; the two paragraphs restating the decision table are cut.automations.mdxopens with one definition instead of two overlapping ones;infrastructure-and-security.mdxleads with "What runs where" instead of "Control plane and execution plane"; the dashboard's self-referential naming callout is folded into the intro; recap and framing lines removed (factory-api,connect-your-factory,troubleshooting,automations).jira.mdxnumbered list no longer breaks;benchmarks.mdxembeds and figures are separated from adjacent paragraphs and list items;---separators and em/en-dash list separators normalized in the self-hosting and API pages; slashed shorthand and the staleoznote onapi-and-sdk/index.mdxremoved.Consistency
Connecting Slack to your factory, and so on); URLs and sidebar labels unchanged.Factory benchmarks,Factory definition syntax);factory-as-code.mdxfrontmatter label matchessidebar.ts;sidebar.tslabel is now "How factories work".platform/orchestration/index.mdxupdated for the renamedfactory-agents.mdxanchor.Left alone, on purpose
api-and-sdk/troubleshooting/errors/*(generated from thesync-error-docstemplate).{/* VISUAL: ... */}screenshot markers (invisible to readers, placed by hand).warp-hosting.mdx.Follow-ups worth a separate PR
start_factory_learning) has a table row but no page of its own.VISUALmarkers.Content design plan
Audience and JTBD: Teams evaluating or operating Warp Factories at launch, reading several pages in one sitting and expecting them to agree with each other and with the product.
Problem: Five weeks of agent and human PRs left the section with contradictory claims (built-in skills, default models), duplicated sections, inconsistent terms and link styles, and leftover AI-draft rhythm.
Goals:
warp-serverat the cited SHA.Purpose and value: Launch-readiness copy was reviewed page by page; this is the cross-page pass.
Content type: Existing feature, conceptual, reference, and procedural pages; no new pages.
Skill and template: Manual audit against
AGENTS.md;style_lint,check_for_broken_links, andnpm run buildfor validation.High-impact scenarios:
Unverified claims
None. UI labels on the touched pages were left as written (they are backed by the existing screenshots); the changed technical claims are listed under Documentation risk with their source files.
Documentation risk
Risk: engineering-review-required
Rationale: Corrects product claims about built-in factory skills, default agent models, default Scorers, and the Factory MCP tool list; the rest is tone, consistency, and cross-link work. The seeded skill files and their factory-wide placement were also confirmed in logic/factory_source_export.go and logic/factoryfile/path.go at the same warp-server commit.
Source files consulted: warp-server/logic/factorysource/defaults/skills.go@cf7e9149d422, seeds.go@cf7e9149d422 (same directory), scorers.go@cf7e9149d422 (same directory), warp-server/router/handlers/public_api/factory_mcp/server.go@cf7e9149d422
Engineering review status: pending
Docs override: none
Validation
npm run buildpasses.check_links.py --internal-only: 4,388 internal links, 0 broken.style_lint.py --all: no new findings on factories pages (remaining hits are pre-existing false positives on "Microsoft Teams" headers and a verbatim product string).Plans:
Co-Authored-By: Warp agent@warp.dev