docs: add DeerFlow docs design plan

Author: zouyonghe

docs/plans/2026-03-08-deerflow-docs-design.md

@@ -0,0 +1,59 @@
+# DeerFlow Agent Runner Docs Design
+
+## Goal
+
+Add DeerFlow Agent Runner documentation to AstrBot docs in the same style as the existing third-party Agent Runner pages, with both Chinese and English coverage.
+
+## Scope
+
+- Add dedicated DeerFlow setup pages in `zh` and `en`
+- Add DeerFlow to the Agent Runner sidebar groups
+- Update Agent Runner overview pages to surface the new entry
+- Update usage pages so the supported runner count and examples match current AstrBot behavior
+- Update high-level introduction pages that list third-party Agent Runners
+
+## Source of Truth
+
+The documentation should follow the current AstrBot implementation instead of guessing DeerFlow behavior. The relevant implementation lives in the main AstrBot repository:
+
+- `astrbot/core/config/default.py`
+- `astrbot/core/agent/runners/deerflow/deerflow_agent_runner.py`
+- `dashboard/src/i18n/locales/zh-CN/features/config-metadata.json`
+- `dashboard/src/i18n/locales/en-US/features/config-metadata.json`
+
+The documented DeerFlow-specific fields are:
+
+- `deerflow_api_base`
+- `deerflow_api_key`
+- `deerflow_auth_header`
+- `deerflow_assistant_id`
+- `deerflow_model_name`
+- `deerflow_thinking_enabled`
+- `deerflow_plan_mode`
+- `deerflow_subagent_enabled`
+- `deerflow_max_concurrent_subagents`
+- `deerflow_recursion_limit`
+
+## Content Strategy
+
+Follow the structure already used by `Dify`, `Coze`, and `Alibaba Cloud Bailian Application`:
+
+1. short introduction with supported version
+2. preparation section that points users to DeerFlow official deployment/config docs
+3. AstrBot-side configuration steps
+4. Agent Runner selection steps
+5. concise operational notes only when backed by code or official DeerFlow docs
+
+The new pages should stay practical and avoid marketing language. They should not invent setup steps that are not validated by AstrBot or DeerFlow official docs.
+
+## Navigation Changes
+
+Update both locale sidebars under the Agent Runner section so DeerFlow appears beside the existing third-party runners.
+
+## Related Copy Updates
+
+Update summary pages that currently list only Dify, Coze, and Bailian so they also mention DeerFlow when describing supported third-party Agent Runners.
+
+## Verification
+
+Run `npm run docs:build` in the docs repository worktree after all edits.

docs/plans/2026-03-08-deerflow-docs.md

@@ -0,0 +1,102 @@
+# DeerFlow Agent Runner Docs Implementation Plan
+
+> **For Claude:** REQUIRED SUB-SKILL: Use superpowers:executing-plans to implement this plan task-by-task.
+
+**Goal:** Add bilingual DeerFlow Agent Runner documentation and update related navigation and overview pages so DeerFlow is documented like the existing third-party runners.
+
+**Architecture:** Create dedicated Markdown pages for DeerFlow in `zh` and `en`, then wire them into the VitePress sidebar and the Agent Runner overview/usage pages. Base every documented field and note on the current AstrBot DeerFlow integration so the docs match shipped behavior.
+
+**Tech Stack:** VitePress, Markdown, `.vitepress/config.mjs`
+
+---
+
+### Task 1: Add planning artifacts
+
+**Files:**
+- Create: `docs/plans/2026-03-08-deerflow-docs-design.md`
+- Create: `docs/plans/2026-03-08-deerflow-docs.md`
+
+**Step 1: Write the validated design doc**
+
+Describe the agreed documentation scope, source of truth, affected files, and verification approach.
+
+**Step 2: Save the implementation plan**
+
+Capture the file list, task order, and verification command for the DeerFlow docs work.
+
+**Step 3: Commit the planning docs**
+
+Run: `git add docs/plans/2026-03-08-deerflow-docs-design.md docs/plans/2026-03-08-deerflow-docs.md && git commit -m "docs: add DeerFlow docs design plan"`
+
+Expected: a new commit containing only planning documents.
+
+### Task 2: Add DeerFlow documentation pages
+
+**Files:**
+- Create: `zh/providers/agent-runners/deerflow.md`
+- Create: `en/providers/agent-runners/deerflow.md`
+- Reference: `zh/providers/agent-runners/dify.md`
+- Reference: `en/providers/agent-runners/dify.md`
+- Reference: `astrbot/core/config/default.py` in the main AstrBot repo
+
+**Step 1: Draft the Chinese page**
+
+Document deployment prerequisites, AstrBot configuration fields, and runner selection steps using the same style as existing Chinese Agent Runner pages.
+
+**Step 2: Draft the English page**
+
+Mirror the same structure and verified fields in English.
+
+**Step 3: Self-check content drift**
+
+Verify the docs mention only real DeerFlow fields and supported defaults from the current AstrBot implementation.
+
+### Task 3: Update navigation and related overview pages
+
+**Files:**
+- Modify: `.vitepress/config.mjs`
+- Modify: `zh/providers/agent-runners.md`
+- Modify: `en/providers/agent-runners.md`
+- Modify: `zh/use/agent-runner.md`
+- Modify: `en/use/agent-runner.md`
+- Modify: `zh/what-is-astrbot.md`
+- Modify: `en/what-is-astrbot.md`
+
+**Step 1: Add DeerFlow to both sidebars**
+
+Insert DeerFlow under the `Agent 执行器` and `Agent Runners` sidebar groups.
+
+**Step 2: Update quick links and overview text**
+
+Add DeerFlow links to the overview pages and extend high-level descriptions to mention DeerFlow.
+
+**Step 3: Fix supported runner counts**
+
+Change the usage pages from four built-in runners to five, and add DeerFlow to the bullet lists and examples.
+
+### Task 4: Verify and prepare PR
+
+**Files:**
+- Verify: site-wide docs build output
+
+**Step 1: Run the docs build**
+
+Run: `npm run docs:build`
+
+Expected: VitePress build completes successfully without new errors.
+
+**Step 2: Review the diff**
+
+Run: `git diff --stat && git diff`
+
+Expected: only the intended DeerFlow docs, navigation, and related copy changes are present.
+
+**Step 3: Commit the docs changes**
+
+Run: `git add . && git commit -m "docs: add DeerFlow agent runner guide"`
+
+Expected: a clean commit for the end-user documentation updates.
+
+**Step 4: Open a pull request**
+
+Push the branch and create a PR with a concise summary of the DeerFlow docs additions and navigation updates.