Skip to content

docs(factories): final copy pass for launch - #571

Merged
hongyi-chen merged 1 commit into
hyc/factory-launchfrom
oz/factories-final-copy-pass
Aug 18, 2026
Merged

docs(factories): final copy pass for launch#571
hongyi-chen merged 1 commit into
hyc/factory-launchfrom
oz/factories-final-copy-pass

Conversation

@hongyi-chen

Copy link
Copy Markdown
Collaborator

Final senior-tech-writer copy pass over the factories section ahead of the #508 launch merge, plus one fix for an open review comment on #508.

Factories copy cleanup

  • index: align the human-in-the-loop line with the quickstart — "approving specs when needed" (matches the review feedback applied in docs(factories): apply Aloke's Loom review #569, which avoided implying every work item has a spec).
  • factory-agents: the model-choice table now says "from the implement agent" instead of the ambiguous bare "implement" (same class of issue flagged in docs(factories): apply Aloke's Loom review #569's review).
  • measure-and-improve: "Use the Dashboard page…" so the metrics page is named consistently with the rest of the page and the factory-dashboard naming note.
  • quickstart: "the work item links to the pull request" (was "links a pull request").
  • how-factories-work / gitlab / jira / github: removed em dashes from procedural and instructional sentences per the style guide (the same rule the docs(factories): apply Aloke's Loom review #569 review enforced on the quickstart). The GitHub label step now reads "…its Foreman name. For example, a factory whose foreman is named payments uses factory:payments."
  • gitlab: bolded and linked the Foreman name field to match the GitHub page.
  • troubleshooting: parallelized the "No pull request appears" fix ("Confirm that…, that…, and that…").
  • factory-as-code: descriptive anchor text for the example link ("example factory definition").

Fix for an open #508 review thread

  • reference/cli/index.mdx: the page had a caution deprecating oz in favor of warp immediately followed by a stale note telling readers to migrate from warp-cli to oz ("replace warp-cli with oz in your scripts"). Folded the warp-cli history into the caution and removed the contradictory note, as flagged by the review bot on chore: gate factory launch #508.

Verified stage naming against the product code rather than "fixing" it: the dashboard Activity view uses Complete (FactoryActivity/stages.ts) while the Slack Home tab uses Completed (slack_app_home.go), so the docs' differing labels are each correct for their surface.

Validation: npm run build passes; style_lint --changed reports no issues in the touched files.

Consistency and style cleanup across the factories section, plus one fix
flagged on #508:

- Align the overview's human-in-the-loop line with the quickstart
  (approving specs when needed)
- Refer to the implement agent explicitly in the model-choice table
- Name the Dashboard page consistently in measure-and-improve
- Replace em dashes in procedural/instructional text (GitHub label step,
  GitLab trigger pointers, Jira caution) per the style guide
- Bold and link the Foreman name field on the GitLab page to match GitHub
- Parallelize the no-PR troubleshooting fix sentence
- Clarify that a finished work item links to the pull request (quickstart)
- Use descriptive anchor text for the factory-as-code example link
- reference/cli: fold the stale warp-cli note into the deprecation
  caution so the page no longer tells readers to migrate to a deprecated
  binary (addresses open review comment on #508)

Co-Authored-By: Warp <agent@warp.dev>
@cla-bot cla-bot Bot added the cla-signed label Aug 18, 2026
@vercel

vercel Bot commented Aug 18, 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 18, 2026 5:15am

Request Review

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

@warp-local-for-testing-only

Copy link
Copy Markdown

Your GitHub account is not connected to Warp. Connect it here.

@warp-agent-staging

Copy link
Copy Markdown
Contributor

Your Warp account is not a member of any team with access to this repository.

@hongyi-chen
hongyi-chen marked this pull request as ready for review August 18, 2026 05:18
@hongyi-chen
hongyi-chen merged commit a279a5f into hyc/factory-launch Aug 18, 2026
4 checks passed
@hongyi-chen
hongyi-chen deleted the oz/factories-final-copy-pass branch August 18, 2026 05:18
@warp-for-oss

warp-for-oss Bot commented Aug 18, 2026

Copy link
Copy Markdown
Contributor

@hongyi-chen

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 PR makes a final copy pass across the Factories docs and removes a contradictory legacy CLI note by folding the warp-cli history into the existing deprecation caution. I reviewed the annotated diff for docs style, link/terminology consistency, comment/test quality, security concerns, and spec drift; no blocking concerns or inline findings were identified.

Concerns

  • None.

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant