Uh oh!
There was an error while loading. Please reload this page.
docs: use one canonical name for the config-authored boot shape - #83
Merged
Merged
Conversation
Two current pages named the same boot shape differently, and the deploy bundle ships one environment template per shape — so a reader who has seen both pages could not tell whether "Config-authored" and "Shipped runtime" were one shape or two, while deploy/index.mdx warns against adapting one template into another. The card guessed deploy/index.mdx's "Shipped runtime" was canonical because it is the newer page. It is not the newer page, and the corpus does not use that name anywhere else: - Three pages carry this table, not two. configure/runtime.mdx:24 also names row one "Config-authored", so the corpus stands 2-1. - The commit order inverts the guess. deploy/index.mdx's table landed in #62 at 13:14; "Config-authored" was written into architecture.mdx and configure/runtime.mdx by #63 at 14:49 — after it, by a pass whose scope was explicitly "outside Deploy" and which reconciled contradictions with the Deploy rewrite. #69 then rewrote architecture.mdx at 17:40 and kept the name. "Shipped runtime" is the oldest of the three writes. - #63 checked its rows "against the deployment bundle that ships with the release, and against the runtime and CLI source that reads it" — the template-mapping authority, and it sits with "Config-authored". - "Artifact-pinned" is the framework's own term (packages/runtime/src/ artifact-reference.ts, packages/cli/src/commands/serve.ts). The paradigm is a past-participle describing where the app came from; "Shipped runtime" is a noun phrase naming the runtime, and is the odd one out even inside its own table. - "the shipped runtime" is already an established generic phrase for the product runtime — three uses upstream, plus environment-variables.mdx:158 ("Nothing in the shipped runtime reads OS_ARTIFACT_FILE"). Promoting it to a proper noun would make the boot-contract reference page use the phrase in two senses at once. Row three differed in substance too, and the evidence settles it rather than contradicting: air-gapped.mdx and the OS_COMPOSED_ARTIFACT_URL entry both state the two claims jointly — the composed shape is the hosted multi-organization shape AND is air-gap-licensed only, enforced at startup. deploy/index.mdx already carried both; architecture.mdx carried only the licence half, so it gains the purpose half and the link to where the refusal is stated. No headings are renamed, so no anchor moves: /docs/architecture#boot-modes still resolves. Fixes#71
os-zhuang
marked this pull request as ready for review
August 18, 2026 12:59
Uh oh!
There was an error while loading. Please reload this page.
This was referenced Aug 18, 2026
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 freeto 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.
Fixes#71
Two current pages named the same boot shape differently:
architecture.mdxcalled row one Config-authored,deploy/index.mdxcalled it Shipped runtime. Rows two and three agreed, which is what made the third name costly — the deploy bundle ships one environment template per shape,deploy/index.mdxwarns against adapting one template into another, and these pages are how a reader picks. A reader who had seen both could not tell whether the two names were one shape or two.What decided it: not the card's guess
The card proposed
deploy/index.mdx's "Shipped runtime" because it is the newer page, and labelled that a guess. It is not the newer page, and five independent lines of evidence point the other way.1. Three pages carry this table, not two.
content/docs/configure/runtime.mdx:24also names row oneConfig-authored. The corpus stands 2-1, and "Shipped runtime" is a hapax — it appears exactly once in the whole corpus as a shape name.2. The commit order inverts the guess.
deploy/index.mdxtable093e848(#62)configure/runtime.mdx+architecture.mdxtables7eaf3a9(#63)architecture.mdxrewrite6711c94(#69)"Shipped runtime" is the oldest of the three writes. #63 landed after the Deploy rewrite, its scope was explicitly "outside Deploy", and its own message says it was reconciling a contradiction with the page #62 had just shipped.
3. The template-mapping authority sits with
Config-authored, not against it. Triage favoureddeploy/index.mdxas "the page that maps shapes to the shipped environment templates". But #63's commit message states its rows were checked "against the deployment bundle that ships with the release, and against the runtime and CLI source that reads it", and that "rows that could not be confirmed against any shipped artifact are not carried forward on a guess". That verification producedConfig-authored.4. The naming paradigm is inherited from the framework, and "Shipped runtime" breaks it.
Artifact-pinnedis the upstream product's own term —packages/runtime/src/artifact-reference.ts,packages/cli/src/commands/serve.ts,packages/cli/test/artifact-pinned-boot.e2e.test.ts, and the framework docs all say "Artifact-pinned boot". The paradigm is a past-participle naming where the app came from: Config-authored / Artifact-pinned / Composed. "Shipped runtime" is a noun phrase naming the runtime, under a column headed "The app comes from" — the odd one out even inside its own table.Config-authoredis also live upstream vocabulary for this shape ("Config-authored stacks are unaffected", contrasted withsys_metadataoverlay writes).5. "The shipped runtime" is already a generic phrase, and the collision lands on the worst page. It is used three times upstream to mean the product runtime as shipped ("not part of the shipped runtime", "the cheap, shipped runtime guard", "ENFORCED in the shipped runtime") — and once right here, at
reference/environment-variables.mdx:158: "Nothing in the shipped runtime readsOS_ARTIFACT_FILE". Promoting it to a proper noun would make the boot-contract reference page use the phrase in two senses at once.Config-authoredhas no such collision.Choosing
Config-authoredalso happens to need the fewest edits:configure/runtime.mdxis already correct, so onlydeploy/index.mdxchanges.Row three: the evidence settles it, it does not contradict
The card flagged row three as differing in substance —
architecture.mdxsaid "Air-gap licensed only" whiledeploy/index.mdxframed it as "the hosted single-app SaaS shape". These are not competing claims; they are the shape's purpose and its requirement, and two independent pages state them jointly:deploy/air-gapped.mdx, under the heading "The hosted multi-organization shape is air-gap-licensed too": the composed shape "requires an air-gap licence andoff, both enforced at startup, and it has its own environment template in the deploy bundle."reference/environment-variables.mdx, onOS_COMPOSED_ARTIFACT_URL: "several organizations sharing one database. That shape has its own template in the deploy bundle, is air-gap-licensed only, and requiresOS_CLOUD_URL=off; both are enforced at startup."deploy/index.mdxalready carried both halves.architecture.mdxcarried the licence half and the multi-org description but not the purpose framing or the enforcement point, so it gains both — worded from the pages above rather than invented.Changes
content/docs/deploy/index.mdx:47— row one renamedShipped runtimetoConfig-authored, with the provenance gloss that makes the name self-explanatory on that page.content/docs/architecture.mdx:121— row three gains "the hosted single-app SaaS shape" and a link to where the startup refusal is stated.No headings renamed, so no anchors move:
/docs/architecture#boot-modes(linked fromoperate/troubleshooting.mdx:34) still resolves, confirmed againstid="boot-modes"in the built HTML. Nothing in the corpus anchors to a shape name.Verification
Gate union re-run at the final commit
7d4ca79:--forcethroughout, per #81 —cache bypasson both tasks confirms real execution, not a replayed green. Separate runs:type-check --force9.311s,build --force1m33.178s.All four
translations.ymlsteps run locally:✓ translations gate passed✓ 20 case(s) ... every rule demonstrated able to fail✓ translation output gate passed (104 pre-existing finding(s) reported)Neither edited page has locale siblings — #63 and #69 deleted them when they rewrote the pages — so this PR adds zero translation debt and the freshness table is unchanged by it.
Rendered HTML read out of the build for both pages:
For the router, not this PR
content/docs/configure/runtime.mdx:24already usesConfig-authored— consistent, no change needed. That is the complete list of other pages carrying the canonical name; it is out of this card's declared file surface and needed no edit either way.deploy/index.mdx's name on the stated grounds that "it is the newer page". That premise is false — see the commit table above. Flagging rather than quietly diverging; a docs rename is cheap to reverse if triage still prefers the other name on grounds other than recency.Generated by Claude Code