Skip to content

docs(factories): section consistency pass + visual callout comments - #590

Merged
hongyi-chen merged 1 commit into
mainfrom
factory/quality-1789-factories-consistency-pass
Aug 20, 2026
Merged

hongyi-chen merged 1 commit into
mainfrom
factory/quality-1789-factories-consistency-pass

Conversation

@warp-agent-staging

Copy link
Copy Markdown
Contributor

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

  • P0 - Removed the leftover OPEN QUESTION for tech review (PR #549) comment in integrations/gitlab.mdx and corrected the claim it was attached to: factory-as-code.mdx only 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.
  • Agent naming - quickstart.mdx and troubleshooting.mdx called 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, matching factory-agents.mdx. Updated both pages to say "Implement" and "agents."
  • Integration title pattern - 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.
  • Troubleshooting opener - Rewrote the "This page covers..." opener to lead with the fix, per docs style.
  • Sidebar casing - 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.
  • Terminal-stage label - factory-dashboard.mdx/how-factories-work.mdx use "Complete and Cancelled"; the Slack integration page said "Completed... and Cancelled." Standardized on "Complete" (majority usage, and pairs correctly with the mermaid diagram's Complete node).
  • Link-label consistency - Bolded a few unbolded Related pages/Next steps links to match the established pattern, and normalized a couple of mismatched labels for the same destination (e.g. GitLab's "connecting your factory" -> "Connect your factory"; quickstart's "Troubleshooting" -> "Troubleshooting Warp Factories" to match the dashboard page).
  • Visual callouts - Added brief {/* 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)

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 for factories/integrations/gitlab and factories/factory-dashboard to 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 removed OPEN QUESTION comment was on main before this PR).
  • No 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

- 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>
@cla-bot cla-bot Bot added the cla-signed label Aug 20, 2026
@vercel

vercel Bot commented Aug 20, 2026 •

Copy link
Copy Markdown

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

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview Aug 20, 2026 11:24pm

Request Review

@warp-agent-staging warp-agent-staging Bot added the warpy-factory Opened by the Warp factory agents label Aug 20, 2026
@warp-agent-staging
warp-agent-staging Bot marked this pull request as ready for review August 20, 2026 23:24
@warp-for-oss

warp-for-oss Bot commented Aug 20, 2026 •

Copy link
Copy Markdown
Contributor

@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 /oz-review on this pull request to retrigger a review (up to 3 times on the same pull request).

Powered by Oz

@warp-for-oss warp-for-oss Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@hongyi-chen
hongyi-chen merged commit 4ced1c8 into main Aug 20, 2026
8 checks passed
@hongyi-chen
hongyi-chen deleted the factory/quality-1789-factories-consistency-pass branch August 20, 2026 23:41
warp-factories Bot pushed a commit that referenced this pull request Aug 24, 2026
- 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-staging[bot] <240773466+warp-agent-staging[bot]@users.noreply.github.com>
Co-authored-by: Warp <agent@warp.dev>

This branch was successfully deployed

1 active deployment
Preview — c7f6d404 Deployed Aug 20, 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