docs: 框架文档重构(导航分组、智能体子章节、File tree、侧边栏标签) by yaozheng-fang · Pull Request #606 · volcengine/veadk-python · GitHub
Skip to content

docs: 框架文档重构(导航分组、智能体子章节、File tree、侧边栏标签)#606

Merged
zakahan merged 3 commits into
mainfrom
docs/source-grounded-reference
Jun 15, 2026
Merged

docs: 框架文档重构(导航分组、智能体子章节、File tree、侧边栏标签)#606
zakahan merged 3 commits into
mainfrom
docs/source-grounded-reference

Conversation

@yaozheng-fang

Copy link
Copy Markdown
Collaborator

基于源码重写并重组了框架文档(中英双语),统一写作风格与页面结构。

导航与结构

  • 入门:安装 / 快速开始(含本地可视化调试)/ 常见问题 / 更新日志,全部拍平。
  • 核心能力
    • 智能体拆为子章节:基本组件、模型管理、Responses API、运行时(NEW)、进阶能力、技能。
    • 多智能体Prompt 管理 提升为同级页面;隧道 移入核心能力。
  • 交互(原「扩展与界面」):前端(VeADK Web + VeADK Frontend)+ A2UI(简化为以用法为主)。
  • 安全可观测 拍平;护栏并入工具
  • 配置API 服务接口 移入 参考 区。

写作与呈现

  • 每页统一三段式:概述(不涉实现细节)→ 可运行的基本用法 → 更多参数/能力(参数用表格,多能力分标题)。
  • 风格:简洁、声明式、少主语;去口语化;尽量不暴露类名/路径。
  • 移除页面 description 副标题;关闭页脚上一页/下一页;标题行内置「复制 Markdown / 打开方式」。
  • 所有目录结构改用 Fumadocs <Files>;隧道架构图改用 Mermaid。
  • 侧边栏支持 status: new 等标签(statusBadgesPlugin)。

其他

  • 新增 docs/AGENT.md:文档写作与维护规范。
  • 已与 main 同步(合并最新代码);pnpm build 全量通过;未包含任何密钥 / .env

🤖 Generated with Claude Code

…erences, agent merge, memory/kb backends, style passes)
…reference

# Conflicts:
#	docs/content/docs/framework/agent/meta.en.json
#	docs/content/docs/framework/agent/meta.json
#	docs/content/docs/framework/configuration.en.mdx
#	docs/content/docs/framework/configuration.mdx
#	docs/content/docs/framework/runtime.en.mdx
#	docs/content/docs/framework/runtime.mdx
…rs, flatten security/observability, file-trees, sidebar badges)

- Getting started: flatten install/quickstart, fold local-debugging into
  quickstart, move troubleshooting in, changelog page.
- Configuration moved into the Reference section; api-server too.
- Agent split into sub-chapters (basic components / model / Responses API /
  runtime[new] / advanced / skills); multi-agent + prompt as siblings.
- Tunnel moved into Core capabilities; Extend&UI renamed to Interaction
  (frontend = VeADK Web + VeADK Frontend; A2UI simplified).
- Flatten security and observability groups; guardrail moved under tools.
- All directory trees use <Files>; tunnel diagram uses mermaid.
- Sidebar status badges (status: new) wired via statusBadgesPlugin.
- Page descriptions removed; prev/next footer disabled; title-row actions.
- Add docs/AGENT.md with the writing + structure conventions.
@zakahan zakahan merged commit fdb44cb into main Jun 15, 2026
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants