Skip to content

[docs]: Docs document link redirection#2203

Open
BG0527 wants to merge 3 commits into
agentscope-ai:mainfrom
BG0527:fix-docs-link
Open

[docs]: Docs document link redirection#2203
BG0527 wants to merge 3 commits into
agentscope-ai:mainfrom
BG0527:fix-docs-link

Conversation

@BG0527

@BG0527 BG0527 commented Jul 14, 2026

Copy link
Copy Markdown
Contributor

关联 issue

AgentScope-Java Version

v2.0.0

Description

Background

docs/v2/ 文档站中大量 Markdown 内部跳转链接缺少 .md 文件后缀,在 GitHub 预览、VS Code、Typora 等标准 Markdown 环境下点击无法正常跳转到目标文件。

Root Cause

  1. 缺少 .md 后缀:编写文档时采用了 Sphinx/Jupyter Book 的隐式扩展名解析约定(省略 .md 也能跳转),但在标准 Markdown 渲染器中无法解析,导致链接失效。涉及纯路径链接(如 ./workspace)和带锚点的链接(如 ./memory#开启压缩)。
  2. 路径错误:harness 目录下引用 ./context 的链接,实际目标 context.md 位于 ../building-blocks/ 目录,属于路径指向错误。

Fix

  1. 添加 .md 后缀:对所有缺少后缀的相对路径链接统一追加 .md,包括纯路径链接(./workspace./workspace.md)和带锚点的链接(./memory#开启压缩./memory.md#开启压缩)。
  2. 修正路径错误:harness 目录下引用 ./context 的链接(filesystem.mdmemory.mdworkspace.md,中英文共 6 个文件)修正为 ../building-blocks/context.md

共修改 32 个文件,修复 224 处 链接(中英文各 112 处)。

Changed files:

1. harness 文档

文件 修复数 说明
docs/harness/architecture.md ~15 纯路径 + 锚点链接添加 .md
docs/harness/workspace.md ~26 纯路径 + 锚点链接添加 .md,./context 路径修正为 ../building-blocks/context.md
docs/harness/compaction.md ~11 纯路径 + 锚点链接添加 .md
docs/harness/channel.md 2 纯路径链接添加 .md
docs/harness/filesystem.md ~6 纯路径链接添加 .md,./context 路径修正
docs/harness/memory.md ~3 纯路径链接添加 .md,./context 路径修正
docs/harness/plan-mode.md ~4 纯路径 + 锚点链接添加 .md
docs/harness/sandbox.md 2 纯路径链接添加 .md
docs/harness/skill.md ~5 纯路径 + 锚点链接添加 .md
docs/harness/subagent.md ~5 纯路径 + 锚点链接添加 .md

(以上每个文件均有 en/zh 两份,共 20 个文件)

2. building-blocks 文档

  • docs/building-blocks/context.md(en/zh) — 5 处纯路径链接添加 .md

3. 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

  • Code has been formatted with mvn spotless:apply
  • All tests are passing (mvn test) — 214 tests, 0 failures
  • Javadoc comments are complete and follow project conventions
  • Related documentation has been updated (e.g. links, examples, etc.)
  • Code is ready for review

@BG0527 BG0527 requested a review from a team July 14, 2026 18:24
@codecov

codecov Bot commented Jul 14, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@AgentScopeJavaBot AgentScopeJavaBot added the area/docs Documentation label Jul 15, 2026
@chickenlj

Copy link
Copy Markdown
Collaborator

@BG0527 感谢贡献,修改后build后的静态页面还能正常跳转吗?

@AgentScopeJavaBot AgentScopeJavaBot left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 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.

Comment thread docs/v2/en/integration/protocol/a2a.md Outdated
## 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).

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[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.

Comment thread docs/v2/zh/integration/protocol/a2a.md Outdated
## 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)。

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[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 AgentScopeJavaBot left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 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.

Comment thread docs/v2/en/integration/protocol/a2a.md Outdated
## 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).

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[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.

Comment thread docs/v2/zh/integration/protocol/a2a.md Outdated
## 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)。

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[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.

@BG0527

BG0527 commented Jul 15, 2026

Copy link
Copy Markdown
Contributor Author

@BG0527 感谢贡献,修改后build后的静态页面还能正常跳转吗?

@chickenlj 感谢评论,我逐文件验证了本次修改涉及的所有 32 个 markdown 文件,逐一检查了所有相对路径链接,确认文件目标均存在于对应位置,build 后的静态页面跳转没有问题。

附:ai review 指出的 a2a.md#spring-boot-starters anchor 不存在的问题(quickstart.md 里没有这个 heading),已在新提交 f4fbb97 中一并修复,移除了该 fragment,链接指向 quickstart 页根。

BG0527 and others added 3 commits July 15, 2026 19:16
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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/docs Documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Bug]: channel.md文档内置的channel链接错误

3 participants