fix(docs): MkDocs 首页路径误贴 + docs/ 契约检查 - #82
Merged
Tanya7z merged 3 commits intoJul 26, 2026
Conversation
docs/index.md 从 README 复制了 ./docs/... 链接，在 docs_dir=docs 下站内导航全断； 改为 docs 相对路径，恢复按角色入口，并对 docs/*.md 禁止再出现 ](./docs/) 误贴。 Co-authored-by: Shiroha <Tanya7z@users.noreply.github.com>
Updated the documentation structure by adding a new directory table and removing the role-based entry section.
Updated links for online resources and module repository.
Tanya7z
marked this pull request as ready for review
July 26, 2026 03:07
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. |
3 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
审查 main@
024512d（依赖清理 + 文档首页改写）后的可验证问题，直接补丁。本轮 push 的 ootb / Docs / changeset-release 均已 success，无新 wf 失败。
BLOCKER · DRY / Demeter（文档契约）
docs/index.md把 README 的仓根相对路径（./docs/guide/...、./docs/dev/npm-publish.md）原样贴进 MkDocs 站。MkDocsdocs_dir=docs，这些链接在站点里变成双重docs/，首页导航与安装/发布指南全部失效。CI 因unrecognized_links: ignore未拦截。修复：
./guide/、./dev/…）MAJOR · OCP（防再贴）
tools/docs-mkdocs.mjs在 build/serve 前扫描手写docs/**/*.md，禁止再出现](./docs/…)/](docs/…)。mkdocs.yml将unrecognized_links调为warn，坏链进入 CI 日志。本轮 push 其余评价（无新补丁）
tools显式声明@sfmc-bds/sdk+ws（DIP）；db-server去掉未用ws；SDK 补@minecraft/server-netpeer；根目录清掉已迁出的 eslint utils / lodash 等。Test plan
](./docs/guide/…)→ 契约检查命中python3 -m mkdocs build成功；site/index.html含href="guide/"