Skip to content

docs: fix unrendered bold, stale names, and stale values - #5625

Open
MasamiYui wants to merge 1 commit into
apache:mainfrom
MasamiYui:docs/fix-doc-rendering-and-stale-values
Open

MasamiYui wants to merge 1 commit into
apache:mainfrom
MasamiYui:docs/fix-doc-rendering-and-stale-values

Conversation

@MasamiYui

Copy link
Copy Markdown
Member

Summary

Point fixes for documentation that either renders wrong on GitHub or npm, or contradicts the code it describes. #5624 lists every item with the source line it was checked against.

  • Unrendered bold. A closing ** right after a full-width and before a letter is not right-flanking under CommonMark, so the asterisks print literally. The colon moves outside the emphasis in three places: the CLI Chinese README, the agent-graph scheduling draft, and the Chinese Nightly notice that scripts/release-cli-package.mjs prepends to the npm README.
  • Stale names. ARCHITECTURE.zh-CN.md: Runtime RunnerRuntimeKernel (matching the English edition and the code), [ENGLISH][English]. docs/agent-swarm.md: AiSdkTurn, not AiSdkBackend, appends the swarm prompt. The README native/ entry now names the Windows task launcher.
  • Stale values.
    • DESIGN.md: drop the info-light/info-dark frontmatter the document itself says does not exist, set surface-overlay-dark to the derived 0.223, and repair one unparseable sentence.
    • packages/ui/README.md: five export surfaces, not four.
    • docs/cli-npm-release*.md: drop a stray version=0.1.0.
    • ACP README: state the 175 → 176 epoch bump as past (feat(cli): isolate ACP MCP per Session (PR5 γ) #5386).
    • Eval troubleshooting: correct the cause of machine path ... is unavailable and refresh stale line references.
    • website/README.md: mention staging.profile: ~.

Fixes #5624

Left out to avoid overlapping open work: the ARCHITECTURE.md projection status (#5292), and the same bold problem in docs/architecture/windows-sandbox-rfc-v1.zh-CN.md (#5342).

Verification

  • GitHub's renderer (gh api -X POST /markdown -f mode=gfm): > **Beta:**CLI renders literal **; > **Beta**:CLI renders <strong>Beta</strong>. The repository's marked gives the same result for all five changed emphasis spans.
  • A whole-document marked render of every non-archive Markdown file finds no remaining literal **, except windows-sandbox-rfc-v1.zh-CN.md, which is left for docs(architecture): reconcile Windows sandbox RFC bilingual pair #5342.
  • Relative-link and heading-anchor checks across all tracked Markdown: 0 broken.
  • npx biome format ., npx biome lint ., npm run check:asf-headers, and node --check scripts/release-cli-package.mjs all pass.
  • Each factual edit was re-checked against the cited source line at 0cb4fc32b.
  • Not run: build, typecheck, and test suites. The only non-Markdown change is one string literal in the release script, and no test asserts on it.

AI use

Select exactly one:

  • No generative tool made a substantive contribution
  • Generative tooling made a substantive contribution

Tool(s) and scope: Claude Code audited the docs against the code, verified each item, and drafted the edits, the issue, and this description. The commit carries a Generated-by: Claude Code trailer.

Checklist

  • Tests cover the change and fail without it (not applicable: documentation and one notice string)
  • Lint, format, typecheck and the affected suites pass locally (lint and format pass; typecheck and suites not run, no TypeScript changed)

Does this PR entail a change in behavior?

  • Yes — described under Summary above
  • No

🤖 Generated with Claude Code

- Bold closed right after a full-width colon and before a letter is not
  right-flanking under CommonMark, so GitHub and npm print the asterisks.
  Move the colon outside the emphasis in the CLI Chinese README, the
  agent-graph scheduling draft, and the Chinese Nightly npm notice.
- ARCHITECTURE.zh-CN.md: `Runtime Runner` -> `RuntimeKernel`, and
  `[ENGLISH]` -> `[English]`.
- agent-swarm.md: `AiSdkTurn`, not `AiSdkBackend`, appends the swarm prompt.
- README native/ entry: name the Windows Runtime Host task launcher.
- DESIGN.md: drop `info-light`/`info-dark` (the document states there is no
  info colour), correct `surface-overlay-dark` to the derived 0.223, and
  repair the unparseable `--warning` sentence.
- ui README: five export surfaces, not four.
- cli-npm-release: drop the stray `version=0.1.0` from the dist-tags step.
- ACP README: state the 175 -> 176 epoch bump as past (apache#5386).
- eval README: `machine path ... is unavailable` means the env var is unset;
  refresh stale install-preflight line references.
- website README: the published .asf.yaml also sets `staging.profile: ~`.

Fixes apache#5624

Generated-by: Claude Code
Co-Authored-By: Claude Code <noreply@anthropic.com>
@github-actions github-actions Bot added the effort/S Under 100 readable lines label Sep 23, 2026

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

effort/S Under 100 readable lines

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: unrendered bold, stale names, and stale values across READMEs and design docs

1 participant