docs(factories): section consistency pass + visual callout comments - #590
Conversation
- Remove leftover GitLab review-question comment and correct the
definition-host claim (GitLab isn't yet a supported definition host).
- Fix agent naming: quickstart and troubleshooting referred to the
Implement agent as "Code" and called the default agents "subagents";
align both with the Implement Agent name shown in the product UI.
- Normalize the GitLab integration page's title/description to the
"Connect X to your factory" pattern used by the other integrations.
- Rewrite the troubleshooting page's opener to lead with the fix,
not "This page covers...".
- Fix the How factories work sidebar label casing and align the
Complete/Completed terminal-stage label between the dashboard and
Slack Home tab docs.
- Normalize a few Related pages/Next steps link labels for consistency.
- Add brief {/* VISUAL: ... */} comments at sections a product
screenshot would help, skipping locations already covered by the
open factory-agents.mdx/how-factories-work.mdx screenshot PR (#589).
Co-Authored-By: Warp <agent@warp.dev>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
@warp-agent-staging[bot] 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 docs-only PR makes a consistency pass across Warp Factories pages: it corrects GitLab definition-hosting wording, default agent terminology, link-label formatting, sidebar casing, and stage naming, and adds hidden MDX visual callout comments for future screenshot placement.
Concerns
- No blocking concerns found in the attached diff.
- No approved or repository spec context was provided, so there was no implementation/spec drift to evaluate.
- The supplemental security pass found no concerns; the changes are documentation copy and hidden MDX comments only.
Verdict
Found: 0 critical, 0 important, 0 suggestions
Approve
Comment /oz-review on this pull request to retrigger a review (up to 3 times on the same pull request).
Powered by Oz
Summary
Editorial consistency pass across the Warp Factories docs (
src/content/docs/factories/**), plus brief{/* VISUAL: ... */}comments at sections where a product screenshot would help. No app code changes; docs only.Fixed
OPEN QUESTION for tech review (PR #549)comment inintegrations/gitlab.mdxand corrected the claim it was attached to:factory-as-code.mdxonly lists Warp-managed and GitHub as definition hosts, so GitLab is not yet a supported definition-hosting repository. The page now says so instead of asserting GitLab-hosted definitions sync like GitHub's.quickstart.mdxandtroubleshooting.mdxcalled the fourth default agent "Code" and the default agents "subagents." Confirmed against the actual product UI (Agents list / agent settings screenshots from PR docs(factories): copy edits and screenshots from launch review #589's branch) that the shipped name is Implement Agent, matchingfactory-agents.mdx. Updated both pages to say "Implement" and "agents."integrations/gitlab.mdx's title/description were inverted ("Connect a factory to GitLab") relative to the other four integrations ("Connect X to your factory"). Normalized.how-factories-work.mdx's sidebar label was "How Factories work" (capitalized mid-label); changed to "How factories work" to match the sentence-case convention used by the other factories sidebar entries.factory-dashboard.mdx/how-factories-work.mdxuse "Complete and Cancelled"; the Slack integration page said "Completed... and Cancelled." Standardized on "Complete" (majority usage, and pairs correctly with the mermaid diagram'sCompletenode).{/* VISUAL: ... */}comments (invisible in the rendered page) at the locations from the ticket's callout table that aren't already covered by an open PR:connect-your-factory.mdx,factory-mcp.mdx,factory-as-code.mdx,factory-dashboard.mdx(x2),measure-and-improve.mdx(x2),automation-filters.mdx, and the GitHub/GitLab/Linear/Jira integration "mention/connect" sections.Decisions / deferred (documented per the ticket's request)
how-factories-work.mdxstage naming ("Specification"/"Implementation" vs. the agent's short "Spec"/"Implement" name) - Left unchanged. PR docs(factories): copy edits and screenshots from launch review #589 (open, launch-review copy edits) already rewrote this exact section and deliberately kept the long-form stage names, so renaming here would both contradict that decision and directly conflict with docs(factories): copy edits and screenshots from launch review #589's hunks.factory-agents.mdxvisual callouts (agents list / agent settings) - Skipped. PR docs(factories): copy edits and screenshots from launch review #589 already adds the realfactory-agents-list.png/factory-agent-settings.pngscreenshots for those exact two sections; a placeholder comment there would be immediately stale.scorers/) and docs: add Factory Dashboard metrics reference (APP-5546) #582 (metrics-reference.mdx) haven't merged yet.factory-dashboard.mdx/measure-and-improve.mdx, Document single-prompt Factory MCP onboarding #585factory-mcp.mdx) touch files this PR also touches; edits here were placed in different sections/lines than their diffs to minimize overlap. A rebase may still be needed depending on merge order.Testing
python3 .agents/skills/style_lint/style_lint.py --changed- 0 errors (83 pre-existing "unrecognized bolded term" warnings on untouched lines in files this PR also edits; not introduced by this change).npm run build- full Astro build succeeds; spot-checked the built HTML forfactories/integrations/gitlabandfactories/factory-dashboardto confirm the P0 fix rendered and that the{/* VISUAL: */}comments are stripped from the visible page (they only appear in the page's hidden raw-markdown<template>, same as the removedOPEN QUESTIONcomment was on main before this PR).computer_use/ new screenshots - this ticket's bar is comments + copy consistency; screenshot capture is an explicit follow-up.Originating thread: https://warpdotdev.slack.com/archives/C09BVK0PL3Y/p1787266196343989