Skip to content

docs: drop a dead link and fix a duplicated character - #618

Open
MincongZhou wants to merge 1 commit into
openpi-dev:mainfrom
MincongZhou:docs/fix-broken-link-and-duplicate-char
Open

MincongZhou wants to merge 1 commit into
openpi-dev:mainfrom
MincongZhou:docs/fix-broken-link-and-duplicate-char

Conversation

@MincongZhou

Copy link
Copy Markdown

Problem

Two defects in the research/design notes.

  1. docs/research/CLAUDE_CODE_WORKFLOW_FANOUT_POLICY_2026-08-23.md:5 links to
    ./CLAUDE_CODE_WORKFLOW_DESIGN_2026-08-23.md. That file does not exist, and never has:

    git log --all --name-status -- "*CLAUDE_CODE_WORKFLOW_DESIGN*"
    # (empty — not a deletion, the path was never committed)

    The only same-dated siblings in docs/research/ are ..._FANOUT_POLICY_2026-08-23.md
    (the linking file itself) and ..._RUNTIME_CONTRACT_2026-08-23.md.

  2. docs/design/OPENPI_WORKFLOW_V2_DESIGN_2026-08-23.md:536, in the deterministic-gate
    acceptance table, reads | Terminal write failure | 无无解释 \running` |`.

Value

The fan-out policy's scope note stops sending readers to a 404, and the acceptance table reads
consistently with the rest of the document that contains it.

Approach

For (1), the unusable link is dropped and the sentence keeps its text.

I deliberately did not redirect it to CLAUDE_CODE_WORKFLOW_RUNTIME_CONTRACT_2026-08-23.md.
That document is called a "运行时合同访谈" in line 437 of the same file and
"version-scoped Workflow contract interview" in docs/research/README.md, while the sentence
calls its target a "生命周期研究". The names do not match, so redirecting would be a guess, and a
wrong redirect is worse than no link. If you know the intended target, one line restores the
navigation.

For (2), the row is aligned with wording this document already uses. Line 72 says:

最终 artifact 写入失败时,磁盘也可能永久保留无解释的 running

So the acceptance row becomes 无解释的 \running`— the doubled 无 was a typo and the 的 was missing, giving无无解释无解释的`.

Validation

  • A relative-link check over all tracked *.md now reports 0 broken links. Before this
    change it reported exactly the one above.
  • bun run checkpass (config/docs/discipline contracts, Web build, biome format, biome
    lint with --error-on-warnings, tsc --noEmit).
  • git diff --check — pass.

No code, test, or config changes; documentation only.

Impact

  • User-visible behavior: none.
  • Model-visible context/tools: none.
  • Runtime/lifecycle: none.
  • Persisted config/data: none.
  • Compatibility/risk: none. The single judgement call is (1) — dropping a link to an
    unknown target instead of redirecting it.

`CLAUDE_CODE_WORKFLOW_DESIGN_2026-08-23.md` was never committed to this
repository, so the scope note in the fan-out policy linked to a 404. The
sentence keeps its text and drops the unusable link; the same-dated
`..._RUNTIME_CONTRACT_...` sibling is called a contract interview in both
line 437 and docs/research/README.md, so redirecting to it would be a guess.

The V2 acceptance row read `无无解释 running`. This document already
describes the condition as `无解释的 running` at line 72, so the row now
matches that wording.
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Sep 23, 2026
@MincongZhou

Copy link
Copy Markdown
Author

The only failing check is Background terminals (Windows), and it is unrelated to this change
(two markdown lines; no code, test, or config touched).

It failed in tests/extensions/git-info/index.test.ts:30 with a Windows file-lock race:

not ok 215 - automatic refresh with a spaced fixture path stays local until /pr explicitly requests GitHub data
  location: 'D:\a\openpi\openpi\tests\extensions\git-info\index.test.ts:30:1'
  error: "EBUSY: resource busy or locked, unlink 'C:\Users\RUNNER~1\AppData\Local\Temp\git info explicit pr-unmutm\bin\gh.exe'"
  code: 'EBUSY'

The rest of that job passed (1778 pass / 1 fail), and Node 22.19.0, Node 24, Node 26 and
Web E2E are all green. The EBUSY cleanup race is pre-existing — the same pattern is called out
as an unchanged leftover surface in the #543 description ("The prior Windows git-read cleanup
EBUSY was not changed or suppressed in this PR").

This account cannot rerun the workflow:

$ gh run rerun 35832762560 --failed
run 35832762560 cannot be rerun; Must have admin rights to Repository.

Could a maintainer rerun the failed job? Thank you.

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

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant