[docs]: Docs document link redirection#2203
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
|
@BG0527 感谢贡献,修改后build后的静态页面还能正常跳转吗? |
AgentScopeJavaBot
left a comment
There was a problem hiding this comment.
🤖 AI Review
This PR fixes 224 broken internal Markdown links across 32 documentation files (English and Chinese, symmetrically) by adding missing .md file suffixes to relative links and correcting 6 incorrect relative paths (./context → ../building-blocks/context.md) in the harness/ directory. The changes are mechanical, well-scoped, and correctly applied — all target files were verified to exist, no double-suffixed links were introduced, and directory-index links (e.g., ../skill/) were properly left untouched. The PR cleanly resolves the issue described in #2198. One pre-existing broken anchor was spotted in lines touched by this PR and is flagged below as a nit.
| ## Spring Boot Starter | ||
|
|
||
| If you're on Spring Boot, prefer `agentscope-spring-boot-starter-a2a-server` — it auto-configures the server and controller. See [Spring Boot Starters](../../docs/quickstart#spring-boot-starters). | ||
| If you're on Spring Boot, prefer `agentscope-spring-boot-starter-a2a-server` — it auto-configures the server and controller. See [Spring Boot Starters](../../docs/quickstart.md#spring-boot-starters). |
There was a problem hiding this comment.
[nit] The anchor #spring-boot-starters does not exist in quickstart.md — that file has headings: Installation, Your first agent, Next steps (no "Spring Boot Starters" section). The .md suffix fix is correct, but the anchor target was already broken before this PR. Since you're already touching this line, consider either adding a ## Spring Boot Starters heading to quickstart.md or removing the #spring-boot-starters fragment so the link resolves to the page root.
| ## Spring Boot Starter | ||
|
|
||
| 如果你使用 Spring Boot,建议直接引入 `agentscope-spring-boot-starter-a2a-server`,自动装配上述 server 和控制器,详见 [Spring Boot Starters](../../docs/quickstart#spring-boot-starters)。 | ||
| 如果你使用 Spring Boot,建议直接引入 `agentscope-spring-boot-starter-a2a-server`,自动装配上述 server 和控制器,详见 [Spring Boot Starters](../../docs/quickstart.md#spring-boot-starters)。 |
There was a problem hiding this comment.
[nit] Same issue as the English counterpart: the anchor #spring-boot-starters does not exist in zh/docs/quickstart.md. The .md suffix fix is correct; the anchor itself is a pre-existing broken target. Consider fixing or removing the fragment while you're here.
AgentScopeJavaBot
left a comment
There was a problem hiding this comment.
🤖 AI Review
This PR fixes 224 broken internal Markdown links across 32 documentation files (English and Chinese, symmetrically) by adding missing .md file suffixes to relative links and correcting 6 incorrect relative paths (./context → ../building-blocks/context.md) in the harness/ directory. The changes are mechanical, well-scoped, and correctly applied — all target files were verified to exist, no double-suffixed links were introduced, and directory-index links (e.g., ../skill/) were properly left untouched. The PR cleanly resolves the issue described in #2198. One pre-existing broken anchor was spotted in lines touched by this PR and is flagged below as a nit.
| ## Spring Boot Starter | ||
|
|
||
| If you're on Spring Boot, prefer `agentscope-spring-boot-starter-a2a-server` — it auto-configures the server and controller. See [Spring Boot Starters](../../docs/quickstart#spring-boot-starters). | ||
| If you're on Spring Boot, prefer `agentscope-spring-boot-starter-a2a-server` — it auto-configures the server and controller. See [Spring Boot Starters](../../docs/quickstart.md#spring-boot-starters). |
There was a problem hiding this comment.
[nit] The anchor #spring-boot-starters does not exist in quickstart.md — that file has headings: Installation, Your first agent, Next steps (no "Spring Boot Starters" section). The .md suffix fix is correct, but the anchor target was already broken before this PR. Since you're already touching this line, consider either adding a ## Spring Boot Starters heading to quickstart.md or removing the #spring-boot-starters fragment so the link resolves to the page root.
| ## Spring Boot Starter | ||
|
|
||
| 如果你使用 Spring Boot,建议直接引入 `agentscope-spring-boot-starter-a2a-server`,自动装配上述 server 和控制器,详见 [Spring Boot Starters](../../docs/quickstart#spring-boot-starters)。 | ||
| 如果你使用 Spring Boot,建议直接引入 `agentscope-spring-boot-starter-a2a-server`,自动装配上述 server 和控制器,详见 [Spring Boot Starters](../../docs/quickstart.md#spring-boot-starters)。 |
There was a problem hiding this comment.
[nit] Same issue as the English counterpart: the anchor #spring-boot-starters does not exist in zh/docs/quickstart.md. The .md suffix fix is correct; the anchor itself is a pre-existing broken target. Consider fixing or removing the fragment while you're here.
@chickenlj 感谢评论,我逐文件验证了本次修改涉及的所有 32 个 markdown 文件,逐一检查了所有相对路径链接,确认文件目标均存在于对应位置,build 后的静态页面跳转没有问题。 附:ai review 指出的 |
The #spring-boot-starters anchor does not exist in quickstart.md (headings are: Installation, Your first agent, Next steps). Remove the fragment so the link resolves to the page root. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
关联 issue
AgentScope-Java Version
v2.0.0
Description
Background
docs/v2/文档站中大量 Markdown 内部跳转链接缺少.md文件后缀,在 GitHub 预览、VS Code、Typora 等标准 Markdown 环境下点击无法正常跳转到目标文件。Root Cause
.md后缀:编写文档时采用了 Sphinx/Jupyter Book 的隐式扩展名解析约定(省略.md也能跳转),但在标准 Markdown 渲染器中无法解析,导致链接失效。涉及纯路径链接(如./workspace)和带锚点的链接(如./memory#开启压缩)。./context的链接,实际目标context.md位于../building-blocks/目录,属于路径指向错误。Fix
.md后缀:对所有缺少后缀的相对路径链接统一追加.md,包括纯路径链接(./workspace→./workspace.md)和带锚点的链接(./memory#开启压缩→./memory.md#开启压缩)。./context的链接(filesystem.md、memory.md、workspace.md,中英文共 6 个文件)修正为../building-blocks/context.md。共修改 32 个文件,修复 224 处 链接(中英文各 112 处)。
Changed files:
1. harness 文档
docs/harness/architecture.mddocs/harness/workspace.md./context路径修正为../building-blocks/context.mddocs/harness/compaction.mddocs/harness/channel.mddocs/harness/filesystem.md./context路径修正docs/harness/memory.md./context路径修正docs/harness/plan-mode.mddocs/harness/sandbox.mddocs/harness/skill.mddocs/harness/subagent.md(以上每个文件均有 en/zh 两份,共 20 个文件)
2. building-blocks 文档
docs/building-blocks/context.md(en/zh) — 5 处纯路径链接添加 .md3. integration 文档
integration/infrastructure/nacos.md(en/zh) — 1 处integration/protocol/a2a.md(en/zh) — 2 处(含quickstart锚点链接添加 .md)integration/protocol/agent-protocol.md(en/zh) — 1 处integration/protocol/overview.md(en/zh) — 1 处integration/skill/overview.md(en/zh) — 2 处Checklist
mvn spotless:applymvn test) — 214 tests, 0 failures