docs(factories): alignment pass — Foreman name bridge, dashboard naming, and guide cross-references - #560
Merged
Conversation
…uide references Second consistency pass over the launch stack, cross-checking the docs against the product and against each other after #557/#558/#559 landed. Verified against warp-server (no change needed): - The alias constraints in factory-as-code match the shared factoryalias.Normalize contract (60 runes; letters, digits, spaces, '-', '_', '.'; case-insensitive uniqueness). - Activity's terminal stage really is labeled 'Complete' while the Slack Home tab uses 'Completed' (slack_app_home.go) — both pages correctly reflect their own surface, so the apparent mismatch stands. Aligned: - factory-as-code: bridge the alias key to its control-room label, Foreman name (#559 introduced the label in the quickstart), and say it @-mentions the foreman, matching the UI copy. - control-room Settings: name the identity fields (name, avatar, Foreman name) and link Foreman name to the alias reference. - run-a-software-factory-in-the-cloud: DIY-loop runs appear in the cloud agent dashboard, not the Factories product's dashboard — use {VARS.DASHBOARD}. - The five DIY-factory guides framed the Factories product page as 'the conceptual overview of the full loop'; their next-step descriptions now say what the destination is (the managed product), and build-a-self-improving-agent deep-links the Self-improvement section it parallels (the reverse link already existed). - set-up-a-software-factory and run-a-software-factory-in-the-cloud intros now point readers to Warp Factories as the managed alternative. Validated: npm run build passes; link checker 3,664 internal / 1,522 external, 0 broken; style_lint adds no new findings on touched files. Co-Authored-By: Warp <agent@warp.dev>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
Author
|
This PR was generated with Warp. Comment   |
Contributor
|
Your GitHub account is not connected to Warp. Connect it here. |
hongyi-chen
marked this pull request as ready for review
August 18, 2026 00:47
Contributor
|
I'm starting a first review of this pull request. I cancelled the in-progress review run because this pull request was closed. Powered by Oz |
hongyi-chen
added a commit
that referenced
this pull request
Aug 18, 2026
* docs(factories): bridge factory:<alias> to the Foreman name label on the GitHub page The Foreman name alignment pass in #560 updated control-room.mdx and quickstart.mdx to link the control room's **Foreman name** field to the definition's `alias` key, but it skipped the GitHub integration page because that page was still in the open PR for #526. The page uses `factory:<alias>` three times without ever saying where <alias> comes from, so a reader who only knows the control room label has no way to work out what their label is actually called. Bridge it on first use, matching the link convention the sibling pages now use. Co-Authored-By: Warp <agent@warp.dev> * docs(factories): address Maggie's review on the GitHub page Two review comments on #526, which merged before they could be applied. Handle: the page said the shared account is @oz-agent. Maggie confirmed it will be @warp-factory. That matches warp-server's factoryGitHubHandleDefault, where FactoryGitHubHandle() is "permanently distinct from GitHubAgentHandle(): callers pick whichever applies, never fall back between them", and githubSeedAutomations materializes it into the seeded mention and assignment filters. Automations: the connect procedure ran to seven steps, of which the last five built an automation by hand. Default GitHub automations are seeded at factory creation, so that work isn't required to connect GitHub, and presenting it as part of setup implied the factory does nothing until you configure a trigger. Connecting is now the two steps it actually takes, followed by what the defaults already do and how to verify, with the custom-automation walkthrough moved to its own section for the cases the defaults don't cover. Sequencing: warp-server#15306 carries the handle rename and is still an open draft, so this page leads the server until it lands. Co-Authored-By: Warp <agent@warp.dev> --------- Co-authored-by: Warp <agent@warp.dev>
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
2 participants
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
Follow-up alignment pass over the launch stack (#508), as requested after #558 merged: a cross-check that pages agree with each other, with the product, and with the pages they reference — including the ~10 pages outside
factories/that link into the section, which no previous pass had covered. 7 files, +10/−10.Verified against the product (no doc change needed)
aliasconstraints are correct.factory-as-code's "60 characters; letters, numbers, spaces,.,_,-; unique case-insensitively" matches the server's sharedfactoryalias.Normalizecontract exactly (logic/factoryalias), which both the API and the file parser use.Complete(FactoryActivity/stages.ts) while the Slack Home tab usesCompleted(slack/slack_app_home.go). Each page matches its own surface, so both stand.src/sidebar.ts), the/platform/software-factory/redirect is in place, and every one of the 11 external links into/factories/resolves.Aligned
alias↔ Foreman name bridge. docs(factories): fix the quickstart's factory-creation entry point #559 renamed the wizard label to Foreman name, but thealiasreference infactory-as-codenever mentioned it. The key's description now names the control-room label and says it @-mentions the foreman, matching the UI copy.control-room's Settings section now names the identity fields and links Foreman name back to thealiasreference.run-a-software-factory-in-the-cloudsaid DIY-loop runs appear in "the Factory dashboard" — those runs land in the cloud agent dashboard, not the Factories product's control room. Now uses{VARS.DASHBOARD}./factories/as "the conceptual overview of the full loop" (or "how X fits into the loop"). A reader lands on a managed product, not concepts for their GitHub Actions wiring. Next-step descriptions now say what the destination is,build-a-self-improving-agentdeep-links the Self-improvement section it parallels (completing the two-way link —how-factories-workalready points back), and the two factory-assembly guides' intros now offer Warp Factories as the managed alternative up front.Validation
npm run build— passesstyle_lint— no new findings on touched files (only pre-existing glossary-candidate advisories)