Skip to content

docs: rewrite the four authored-prose lines that still said "Console" - #106

Merged
os-zhuang merged 1 commit into
mainfrom
claude/issue-101-authored-prose-in-fences
Aug 18, 2026
Merged

docs: rewrite the four authored-prose lines that still said "Console"#106
os-zhuang merged 1 commit into
mainfrom
claude/issue-101-authored-prose-in-fences

Conversation

@os-zhuang

Copy link
Copy Markdown
Contributor

Fixes#101

Verified at commit 5c14215.

What changed

Four lines, all of them content an author wrote that a code fence happens to render in a monospace box.

File:lineWhat it wasWhat it is
build/marketplace.mdx:46You ─→ Console ─→ Marketplace tab …You ─→ ObjectOS ─→ Marketplace tab …
build/marketplace.mdx:50Console re-renders with newThe page re-renders with new
reference/field-types.mdx:225├─► Console: form widget + list column├─► UI: form widget + list column
reference/cli.mdx:38# API only (no Console/Account)# API only (no UI/Account portals)

Untouched, as ruled: every /_console/ URL in the corpus (the diff contains no line matching _console), and the command os start --no-ui itself, which is copy-run and is byte-identical — only the comment after the hash changes. The five in-fence occurrences in quickstart.mdx are #94's and are not touched here.

The check that is the deliverable: what a reader now sees

The defect was visible on one screen in reference/cli.mdx — a fenced comment and a flag table three screens apart, naming the same flag two different ways. I read the prerendered HTML from the production build (apps/docs/.next/server/app/en/docs/…), not the source, for all three pages.

Rendered reference/cli.mdx, the fenced block:

os start --home /var/lib/objectos # persistent home dir
os start --no-ui # API only (no UI/Account portals)

and the flag table row on the same rendered page: --no-ui → "Disable the UI and Account portals". One vocabulary, both places.

Sweeping the rendered text of all three English pages for the surface nouns:

Rendered pageSurface vocabulary present
build/marketplaceObjectOS, Setup, UI
reference/field-typesObjectOS, UI, the UI
reference/cliObjectOS, the UI, the UI enabled

Console appears zero times in the rendered English text of all three. No fourth or fifth spelling was introduced — those are the three names #79 landed (ObjectOS for a destination, the UI / UI for the capability and the stack layer, Setup for administration).

Why these words and not others

Checked against what #79 actually landed rather than pattern-matched:

Diagram alignment, measured in display columns

Counted as display columns, not bytes — the box-drawing characters are multi-byte (the field-types branch lines are 41 code points but 47 bytes), so a byte count would have misled. Measured on the rendered output:

marketplace flow diagram — the three stay in column 50 and the four text-block lines stay at indent 39. The node line grows one column (56 → 57), which moves Install from column 49 to 50, so the arrow spine now descends from its first character instead of its second. The one invariant that could have broken is the spine, and it did not move.

field-types diagram — every branch stays at indent 3; the block is ragged right with nothing aligned to the right edge, so shortening Console: to UI: changes no relationship.

cli.mdx — the comment hash stays in column 39; only the text after it changed.

Verification

All at 5c14215, after the final commit.

  • turbo run type-check build --filter=@objectos/docs --force — both cache bypass, force executing (6cdd55539dc94ec8, cc2e9329a2da2066), Tasks: 2 successful, 2 total, 0 cached.
  • check-translations.mjs✓ translations gate passed.
  • check-translation-ownership.mjs — 0 translation artifacts, 3 other files (TRANSLATION_BOT_LOGIN unset, so reporting).
  • check-translation-output.mjs --self-test20 case(s) … every rule demonstrated able to fail, then --files as CI runs it on a PR: blocking on 0 changed translation(s), exit 0.

Locale staleness this introduces, measured against origin/main in a second worktree rather than assumed: 6 new fence findings (marketplace.zh-Hans, field-types.{de,es,fr,ja,ko}) and one shifted (marketplace.zh-Hans#4#2). All are non-blocking — the gate's PR scope is changed locale files, and this PR changes none. This is the designed outcome of AGENTS.md's translation split; the next translation pass clears them.


Generated by Claude Code

#79 retired "Console" as the name of the end-user surface but held every
in-fence occurrence byte-identical, on the rationale that fences hold
terminal output a reader compares against their own. Nine occurrences
survived under that rule. Five of them are genuine output (the os start
banners in quickstart.mdx). The other four are authored content that a
fence happens to render in a monospace box, so the rationale never
reached them:
- build/marketplace.mdx:46,50 - two lines of an ASCII flow diagram
- reference/field-types.mdx:225 - a branch label in the "how fields
flow" diagram
- reference/cli.mdx:38 - a comment inside a bash example
cli.mdx is where the cost showed on one screen: the fenced comment read
"API only (no Console/Account)" while the flag table below it read
"Disable the UI and Account portals" - two vocabularies for one flag,
with no way for a reader to tell which is current.
The replacements use the vocabulary #79 actually landed, not a new one:
ObjectOS where a destination needs a name (the sentence directly above
the marketplace diagram already reads "When you open ObjectOS"), UI as a
stack-layer label beside REST and Audit, and a noun-drop rewrite for the
re-render step, matching step 5 of the same page's install flow
("Reload the page"). "ObjectOS re-renders" was rejected there because
the diagram ends with "Done - no restart" and would invite the reader to
read a re-render as a restart.
Untouched, as ruled: every /_console URL, and the command os start
--no-ui itself, which is copy-run and stays byte-identical - only the
comment after the hash changes.
Diagram geometry verified in display columns, not bytes. In the
marketplace diagram the three arrows stay in column 50 and the four
text-block lines stay at indent 39; the one-column growth of the node
line moves "Install" from column 49 to 50, so the arrow spine now
descends from its first character instead of its second.
English only. Locale siblings are left alone and report stale, per
AGENTS.md; the blocking scope of the output gate is changed locale
files, of which this PR has none.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01CJPxtTxoxTUnjNdTbiEaRa
@os-zhuang
os-zhuang marked this pull request as ready for review August 18, 2026 14:47
@os-zhuang
os-zhuang merged commit 4204d5e into mainAug 18, 2026
2 checks passed
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Four code-fence lines still say "Console" but are authored prose, not product output

2 participants

@os-zhuang@claude