docs(factories): editorial pass on infrastructure and security - #540
Draft
hongyi-chen wants to merge 1 commit into
Draft
docs(factories): editorial pass on infrastructure and security#540hongyi-chen wants to merge 1 commit into
hongyi-chen wants to merge 1 commit into
Conversation
Rewrites the Factories infrastructure and security page in the house voice used across the rest of the docs, and applies the same clarity pass to the two self-hosting paragraphs touched in the same change. - Leads with what the reader controls instead of a hedged summary, and replaces third-person "customer"/"supported"/"applicable" phrasing with plain second person. - Reuses the existing orchestration-vs-execution framing from the self-hosting docs rather than introducing new plane vocabulary. - Cuts four stacked decision tables down to the one comparison that earns a table, and moves the rest into the standard bold-term list format. Fixes the inconsistent bolding in table cells. - Drops implementation detail that belongs on the pages it links to (runner file resolution, hosted shape rejection, worker principals). - Adds the Early Access and Enterprise gating callout, promotes the "self-hosting is not a data guarantee" caveat into a caution, and adds a Related pages section. - Converts relative page links to the root-relative form with trailing slashes used everywhere else in the repo. Verified: astro check 0 errors, 377 pages built, all internal links on the edited pages resolve, style lint clean apart from the same bold table-header warnings the existing self-hosting page produces. Co-Authored-By: Warp <agent@warp.dev>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Collaborator
Author
|
This PR was generated with Warp. |
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 pass on top of #523. The content and verified facts are unchanged — this is a clarity and house-voice rewrite of
factories/infrastructure-and-security.mdx, plus the same treatment for the two self-hosting paragraphs that PR touches.Targets
hyc/factories-infraso it can be merged into #523 before that PR lands.What was unclear
The page read like a compliance memo rather than Warp docs:
Choose execution, inference, and storage independently) largely restated the two above it.**Environment**bold,Runnernot;**Checkout and commands**bold,Computenot. This appears to have been driven by the style linter's glossary check rather than by meaning.../platform/environments). Every other page in the repo uses root-relative links with trailing slashes; this was the only file using the other form.---section breaks, no Related pages section, and no Early Access / Enterprise gating treatment even though most of the page describes Enterprise-gated controls.What changed
platform/self-hosting/, instead of introducing fresh "control plane / execution plane" vocabulary for the same idea.* **Term** - descriptionformat.:::note[Early access]for Early Access and Enterprise features,:::cautionfor "self-hosting is customer-hosted execution, not a guarantee that factory data stays in your network."No new product claims. Every fact, caveat, and eligibility statement from #523 is preserved.
Validation
npm run typecheck— 0 errorsnpm run build— 377 pages built, Complete!unrecognized-termwarnings on the bold table header row, the identical patternplatform/self-hosting/index.mdxalready produces