Skip to content

fix(docs): 相对链接不得逃出 docs_dir(OCP 契约) - #83

Merged
Tanya7z merged 1 commit into
mainfrom
cursor/bc-ab200964-a3a7-4c09-9460-7867c64478bc-cc3a
Jul 27, 2026
Merged

fix(docs): 相对链接不得逃出 docs_dir(OCP 契约)#83
Tanya7z merged 1 commit into
mainfrom
cursor/bc-ab200964-a3a7-4c09-9460-7867c64478bc-cc3a

Conversation

@cursor

@cursor cursor Bot commented Jul 26, 2026

Copy link
Copy Markdown
Contributor

Summary

审查 main@a4cf856(合入 #82:MkDocs 首页路径 + ./docs/ 契约)后的可验证残余问题,直接补丁。

本轮 push 的 ootb / Docs / changeset-release 均已 success,无新 wf 失败。

MAJOR · OCP / DRY / Demeter(文档契约)

#82assertNoRepoRootDocsLinks 只特判 ](./docs/…) 前缀,但站内仍有 13 处 ](../../sfmc|tools|.github|…) 逃出 docs_dir——Pages 上全部 404。为每种坏前缀继续打洞违反 OCP;与 mkdocs exclude 重复维护 plan/archive 跳过列表也不完整(漏 reviews)。

修复:

  • 契约升级为解析相对链接 → 必须落在 docs/(单一权威规则,同时覆盖 README 误贴与仓外相对路径)
  • 仅跳过 TypeDoc 生成目录 reference/sdk
  • 把 13 处仓外目标改为 GitHub 绝对 URL(configs/pack-update.json 为 gitignore,改为指向 config.ts DEFAULTS)
  • docs/CONTRIBUTING-DOCS.md 写明链接约定

本轮 push 其余评价

Test plan

  • 负向:临时写入 ](../../sfmc/…) → 契约命中并 exit 1
  • 清理后 npm run docs:build 成功(无 not_found 警告)
  • CI Docs on this PR
Open in Web View Automation 

将 ./docs/ 前缀特判升级为解析后必须落在 docs/ 内的单一规则,
并把 13 处 ../../仓内路径 改为 GitHub 绝对 URL,避免 Pages 404。

Co-authored-by: Shiroha <Tanya7z@users.noreply.github.com>
@Tanya7z
Tanya7z marked this pull request as ready for review July 27, 2026 06:48
@cursor

cursor Bot commented Jul 27, 2026

Copy link
Copy Markdown
Contributor Author

Bugbot is not enabled for your account, so this pull request was not reviewed.

Enable Bugbot in the Cursor dashboard to get automatic reviews on future PRs.

@Tanya7z
Tanya7z merged commit 9802e0f into main Jul 27, 2026
1 check passed
Sign up for free to 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.

2 participants