From 6bbedf1b1e405c2f20e80400b49a123eedfd0fe1 Mon Sep 17 00:00:00 2001 From: Claude Date: Fri, 7 Aug 2026 14:08:38 +0000 Subject: [PATCH] =?UTF-8?q?docs:=20=E4=BF=AE=E6=AD=A3=20CONTRIBUTING.md=20?= =?UTF-8?q?/=20ROADMAP.md=20=E7=9A=84=203=20=E6=9D=A1=E6=AD=BB=E9=93=BE=20?= =?UTF-8?q?(#3545)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 三条链接的目标在磁盘上都不存在,且这两个文件不在任何门禁的扫描面内 (check-doc-links 的 SCAN_ROOTS 是 content/docs + examples + 根 README; lychee 扫 content/docs、docs、README.md),所以一直静默失效。 - CONTRIBUTING.md:153 `./docs/spec/architecture.md`(`docs/spec/` 目录根本不存在) → `./content/docs/guide/architecture.md`。未按 issue 建议指向 `docs/ARCHITECTURE.md`: 该文件的 H1 是 "Console Streamlining - Architecture Guide",讲的是 app-shell/providers 那次重构的迁移路径,而链接所在的 "Architecture Overview" 一节讲的是 monorepo 包结构与 设计原则 —— `content/docs/guide/architecture.md`(标题即 "Architecture Overview", 含 Package Structure / Core Philosophy 两节)才是这句 "for details" 真正承诺的内容。 链接文字同时改成目标文档的真实标题,避免用旧标签包装另一个目标。 - CONTRIBUTING.md:469 `./docs/README.md` → 删除整句。仓库里没有、也从未有过 "Documentation Guide" 这份文档;它承诺的细节就在它所处的 Documentation 一节里 (Writing Documentation / Documentation Guidelines / Link Conventions / Validating Links), 前一句也已自成完整陈述。按 #3506/#3509 的先例,如实删除而不是改指别的文档。 - ROADMAP.md:1892 扩展名错 `.mdx` → `.md`。真实文件是 `content/docs/guide/plugin-development.md`;保持相对文件链接的写法,与同一列表里 `./CONTRIBUTING.md`、`./QUICK_REFERENCE.md` 一致。 本 PR 只做第 1 步。issue 的第 2 步(把这两个文件与 `docs/**` 纳入 SCAN_ROOTS) 刻意留下,不碰 scripts/check-doc-links.mjs。 Co-Authored-By: Claude Fable 5 Claude-Session: https://claude.ai/code/session_01GTRjn8xBqp75dk7kFupVRt --- CONTRIBUTING.md | 4 +--- ROADMAP.md | 2 +- 2 files changed, 2 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0996100558..360998d250 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -150,7 +150,7 @@ packages/ 4. **Tree Shakable**: Modular imports, no monolithic bundles 5. **Zero React in Core**: Core package has no React dependencies -See [Architecture Documentation](./docs/spec/architecture.md) for details. +See the [Architecture Overview](./content/docs/guide/architecture.md) guide for details. ## Writing Tests @@ -466,8 +466,6 @@ Fumadocs is configured with `baseUrl: '/docs'`, which means all documentation pa Link validation runs automatically via GitHub Actions on all PRs using lychee-action. This checks for broken internal and external links. -See [Documentation Guide](./docs/README.md) for details. - ## Versioning and Releases We use [Changesets](https://github.com/changesets/changesets) for version management and automated releases. diff --git a/ROADMAP.md b/ROADMAP.md index 594dff7522..4a913e1289 100644 --- a/ROADMAP.md +++ b/ROADMAP.md @@ -1889,7 +1889,7 @@ All 313 `@object-ui/fields` tests pass. - [CONTRIBUTING.md](./CONTRIBUTING.md) — Contribution guidelines - [QUICK_REFERENCE.md](./QUICK_REFERENCE.md) — Developer quick reference -- [Plugin Development Guide](./content/docs/guide/plugin-development.mdx) +- [Plugin Development Guide](./content/docs/guide/plugin-development.md) ---