Skip to content

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

Description

@os-zhuang

Found while executing #79. Filed rather than folded in, because fixing it would cross the ⛔ that card carries.

What is there

#79's category 3 keeps every occurrence inside a code fence, on the stated grounds that fenced blocks are "output a reader compares against their own terminal, and altering them makes the docs lie about what the product prints". There are exactly nine in-fence occurrences and PR #100 left all nine byte-identical.

Only five of the nine are output the product prints — the two os start banner blocks in content/docs/quickstart.mdx (lines 40, 46, 48, 151, 153), which #94 already owns.

The other four are content an author wrote, that happens to live inside a fence:

File:lineFence kindContent
content/docs/build/marketplace.mdx:46```text ASCII flow diagramYou ─→ Console ─→ Marketplace tab ─→ pick app ─→ Install
content/docs/build/marketplace.mdx:50same diagramConsole re-renders with new objects / views / permissions
content/docs/reference/field-types.mdx:225``` ASCII "how fields flow" diagram├─► Console: form widget + list column
content/docs/reference/cli.mdx:38```bash example blockos start --no-ui # API only (no Console/Account)

None of the four is printed by anything. They are prose and diagrams that a fence happens to render in a monospace box, so the rationale for the ⛔ does not reach them — but the ⛔ is written as "inside a fence", so PR #100 honoured it and reported instead of deciding.

Why it is worth recording

reference/cli.mdx is where the cost shows on one screen. After #100 the flag table reads:

| --no-ui | Disable the UI and Account portals |

while the example block three screens above it still reads # API only (no Console/Account). A reader who scrolls sees the retired name and the new wording on the same page and cannot tell which is current.

The two diagrams are milder — a reader parses You ─→ Console ─→ Marketplace tab as a picture, not as a name to remember — but they are the last places in the English corpus where the end-user surface is called Console outside genuine product output.

The call

  • Rewrite the four. They are authored content, so the "docs must not lie about what the product prints" argument does not apply. You ─→ ObjectOS ─→ Marketplace tab, ├─► UI: form widget + list column, # API only (no UI/Account portals). Finishes the rename with no risk to anything copyable — none of the four is a command a reader runs verbatim except the cli.mdx line, whose changed text is a comment.
  • Leave them. Keeps "nothing inside a fence changes" as a rule one grep verifies, which is worth something on a 47-file rename. Costs the cli.mdx inconsistency above.
  • Rewrite only cli.mdx:38. Fixes the one visible contradiction, leaves the two diagrams, and gives up the mechanical rule for a case-by-case one.

Not a correctness defect either way — nobody is misled about behaviour, only about vocabulary. Recording it so the decision is made once rather than rediscovered by the next person who greps for the retired name and finds four hits.

Checked for duplicates first: #94 covers the quickstart.mdx banner blocks and the plugin list, which are a different defect (the sample does not match the real CLI); no open issue covers these four.

Related: #79, #94.


Generated by Claude Code

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions