Skip to content

docs: fix broken links on docs landing pages and README security anchors #4967

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
simpleqt wants to merge 3 commits into from
Closed

docs: fix broken links on docs landing pages and README security anchors #4967

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
25418b8
docs(readme): strip stray variation selector from security anchors
simpleqt Aug 23, 2026
6f52f71
fix(docs): repair broken relative links in docs landing pages
simpleqt Aug 23, 2026
7b229d3
Merge branch 'main' into fix-docs-landing-links
WillemJiang Aug 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ DeerFlow has newly integrated the intelligent search and crawling toolset indepe
- [Scheduled Tasks](#scheduled-tasks)
- [Terminal Workbench (TUI)](#terminal-workbench-tui)
- [Documentation](#documentation)
- [⚠️ Security Notice](#️-security-notice)
- [⚠️ Security Notice](#-security-notice)

@willem-bd willem-bd Aug 25, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

[P1] Keep the variation selector in the security anchor. GitHub renders the heading ID as user-content-️-security-notice and its permalink as #️-security-notice. The new #-security-notice therefore no longer targets the heading; the same regression exists in the four translated README files. Please restore the original fragment in all five files.

@simpleqt simpleqt Aug 25, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Confirmed — the heading's ⚠️ carries U+FE0F and GitHub preserves it in the slug, so my tool's normalization that stripped the variation selector was wrong here. The original fragment was correct in all five files; reverting.

- [Improper Deployment May Introduce Security Risks](#improper-deployment-may-introduce-security-risks)
- [Security Recommendations](#security-recommendations)
- [Contributing](#contributing)
Expand Down
2 changes: 1 addition & 1 deletion README_fr.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ DeerFlow intègre désormais le toolkit de recherche et de crawling intelligent
- [Tâches planifiées (Scheduled Tasks)](#tâches-planifiées-scheduled-tasks)
- [Atelier terminal (TUI)](#atelier-terminal-tui)
- [Documentation](#documentation)
- [⚠️ Avertissement de sécurité](#️-avertissement-de-sécurité)
- [⚠️ Avertissement de sécurité](#-avertissement-de-sécurité)
- [Contribuer](#contribuer)
- [Licence](#licence)
- [Remerciements](#remerciements)
Expand Down
2 changes: 1 addition & 1 deletion README_ja.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ DeerFlowは、BytePlusが独自に開発したインテリジェント検索・
- [スケジュールタスク (Scheduled Tasks)](#スケジュールタスク-scheduled-tasks)
- [ターミナルワークベンチ (TUI)](#ターミナルワークベンチ-tui)
- [ドキュメント](#ドキュメント)
- [⚠️ セキュリティに関する注意](#️-セキュリティに関する注意)
- [⚠️ セキュリティに関する注意](#-セキュリティに関する注意)
- [コントリビュート](#コントリビュート)
- [ライセンス](#ライセンス)
- [謝辞](#謝辞)
Expand Down
2 changes: 1 addition & 1 deletion README_ru.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ DeerFlow интегрирован с инструментарием для ум
- [Запланированные задачи (Scheduled Tasks)](#запланированные-задачи-scheduled-tasks)
- [Терминальная панель (TUI)](#терминальная-панель-tui)
- [Документация](#документация)
- [⚠️ Безопасность](#️-безопасность)
- [⚠️ Безопасность](#-безопасность)
- [Участие в разработке](#участие-в-разработке)
- [Лицензия](#лицензия)
- [Благодарности](#благодарности)
Expand Down
2 changes: 1 addition & 1 deletion README_zh.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ DeerFlow 新近集成了 BytePlus 自研的智能搜索与抓取工具集——[
- [定时任务 (Scheduled Tasks)](#定时任务-scheduled-tasks)
- [终端工作台 (TUI)](#终端工作台-tui)
- [文档](#文档)
- [⚠️ 安全使用](#️-安全使用)
- [⚠️ 安全使用](#-安全使用)
- [参与贡献](#参与贡献)
- [许可证](#许可证)
- [致谢](#致谢)
Expand Down
20 changes: 10 additions & 10 deletions frontend/src/content/en/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,19 +28,19 @@ Start with the conceptual overview first.

Start with the Harness section. This path is for teams who want to integrate DeerFlow capabilities into their own system or build a custom agent product on top of the DeerFlow runtime.

- [DeerFlow Harness](./docs/harness)
- [Quick Start](./docs/harness/quick-start)
- [Configuration](./docs/harness/configuration)
- [Customization](./docs/harness/customization)
- [DeerFlow Harness](./harness)

@willem-bd willem-bd Aug 25, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

[P1] Preserve the /docs route segment. Nextra renders this href unchanged, so from /en/docs the browser resolves ./harness to /en/harness, but only /en/docs/harness is generated. The same applies to the other newly shortened English links and the corresponding Chinese links. Please retain ./docs/... or use /docs/... so LocalizedDocsLink produces the localized docs route.

@simpleqt simpleqt Aug 25, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

You're right, and thank you for the route-level analysis. I traced back why these were changed: my static link audit resolved ./docs/harness against the source tree and expected a matching file path, which Nextra's route generation doesn't follow — the /docs/ segment is exactly what makes these resolve on the generated site. The originals were correct; reverting.

- [Quick Start](./harness/quick-start)
- [Configuration](./harness/configuration)
- [Customization](./harness/customization)

### If you want to deploy and use DeerFlow

Start with the App section. This path is for teams who want to run DeerFlow as a complete application and understand how to configure, operate, and use it in practice.

- [DeerFlow App](./docs/application)
- [Quick Start](./docs/application/quick-start)
- [Deployment Guide](./docs/application/deployment-guide)
- [Workspace Usage](./docs/application/workspace-usage)
- [DeerFlow App](./application)
- [Quick Start](./application/quick-start)
- [Deployment Guide](./application/deployment-guide)
- [Workspace Usage](./application/workspace-usage)

## Documentation structure

Expand Down Expand Up @@ -79,13 +79,13 @@ The App section is written for teams who want to deploy DeerFlow as a usable pro

The Tutorials section is for hands-on, task-oriented learning.

- [Tutorials](./docs/tutorials/first-conversation)
- [Tutorials](./tutorials/first-conversation)

### Reference

The Reference section is for detailed lookup material, including configuration, runtime modes, APIs, and source-oriented mapping.

- [Reference](./docs/reference/model-providers)
- [Reference](./reference/model-providers)

## Choose the right path

Expand Down
16 changes: 8 additions & 8 deletions frontend/src/content/zh/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,19 +28,19 @@ DeerFlow 是一个用于构建和运行 Agent 系统的框架。它提供了一

从 Harness 章节开始。这条路径适合想将 DeerFlow 功能集成到自己系统中，或基于 DeerFlow 运行时构建自定义 Agent 产品的团队。

- [DeerFlow Harness](./docs/harness)
- [快速上手](./docs/harness/quick-start)
- [配置](./docs/harness/configuration)
- [自定义与扩展](./docs/harness/customization)
- [DeerFlow Harness](./harness)
- [快速上手](./harness/quick-start)
- [配置](./harness/configuration)
- [自定义与扩展](./harness/customization)

### 如果你想部署和使用 DeerFlow

从应用章节开始。这条路径适合想将 DeerFlow 作为完整应用运行，并了解如何配置、运维和实际使用的团队。

- [DeerFlow 应用](./docs/application)
- [快速上手](./docs/application/quick-start)
- [部署指南](./docs/application/deployment-guide)
- [工作区使用](./docs/application/workspace-usage)
- [DeerFlow 应用](./application)
- [快速上手](./application/quick-start)
- [部署指南](./application/deployment-guide)
- [工作区使用](./application/workspace-usage)

## 文档结构

Expand Down
Loading