Skip to content

Commit ac95373

Browse files
committed
docs: fix documentation structure and add npm links
- Remove duplicate features section in index.md - Update version badge in README.md to 2.1.9 - Add npm link to social links in theme config - Add npm link to navigation menu - Optimize sidebar structure for better organization - Fix broken link to contributing guide
1 parent 0dffe5e commit ac95373

File tree

6 files changed

+76
-42
lines changed

6 files changed

+76
-42
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
**AI 思维流编排引擎**
88

9-
[![Version](https://img.shields.io/badge/version-2.1.0-blue.svg)](https://github.com/Agions/taskflow-ai)
9+
[![Version](https://img.shields.io/badge/version-2.1.9-blue.svg)](https://github.com/Agions/taskflow-ai)
1010
[![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
1111
[![Node.js](https://img.shields.io/badge/Node.js-20+-339933?logo=node.js)](https://nodejs.org/)
1212
[![TypeScript](https://img.shields.io/badge/TypeScript-5.0+-3178C6?logo=typescript)](https://www.typescriptlang.org/)

docs/.vitepress/config-internal/nav.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,9 @@ export const nav = [
4747
{ text: '常见问题', link: '/faq' },
4848
{ text: '故障排除', link: '/troubleshooting/common-issues' },
4949
{ text: '更新日志', link: '/changelog' },
50-
{ text: '贡献指南', link: '/guide/contributing' },
51-
{ text: 'GitHub', link: 'https://github.com/agions/taskflow-ai' }
50+
{ text: '贡献指南', link: '/development/contributing' },
51+
{ text: 'GitHub', link: 'https://github.com/agions/taskflow-ai' },
52+
{ text: 'NPM', link: 'https://www.npmjs.com/package/taskflow-ai' }
5253
]
5354
}
5455
];

docs/.vitepress/config-internal/sidebar.ts

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -112,13 +112,25 @@ export const sidebar = {
112112
{ text: '开发者指南', link: '/development/developer-guide' },
113113
{ text: '贡献指南', link: '/development/contributing' }
114114
]
115-
},
115+
}
116+
],
117+
118+
'/testing/': [
119+
{
120+
text: '🧪 测试指南',
121+
collapsed: false,
122+
items: [
123+
{ text: '测试文档', link: '/testing/' }
124+
]
125+
}
126+
],
127+
128+
'/deployment/': [
116129
{
117-
text: '🧪 测试与部署',
130+
text: '🚀 部署指南',
118131
collapsed: false,
119132
items: [
120-
{ text: '测试指南', link: '/testing/' },
121-
{ text: '部署指南', link: '/deployment/' }
133+
{ text: '部署文档', link: '/deployment/' }
122134
]
123135
}
124136
],
@@ -136,12 +148,12 @@ export const sidebar = {
136148
}
137149
],
138150

139-
'/examples/': [
151+
'/mcp/': [
140152
{
141-
text: '📦 示例文档',
153+
text: '🔌 MCP 集成',
142154
collapsed: false,
143155
items: [
144-
{ text: 'PRD 示例', link: '/examples/example-prd' }
156+
{ text: 'MCP 文档', link: '/mcp/' }
145157
]
146158
}
147159
]

docs/.vitepress/config-internal/theme.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@ export const themeConfig = {
99

1010
// 社交链接
1111
socialLinks: [
12-
{ icon: 'github', link: 'https://github.com/agions/taskflow-ai' }
12+
{ icon: 'github', link: 'https://github.com/agions/taskflow-ai' },
13+
{ icon: { svg: '<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path fill="currentColor" d="M12 1.608l-9.9 4.02v10.392l9.9 4.372 9.9-4.372V5.628L12 1.608zm0 2.19l7.2 2.928v7.348L12 16.698l-7.2-2.624V6.726L12 3.798z"/></svg>' }, link: 'https://www.npmjs.com/package/taskflow-ai' }
1314
],
1415

1516
// 页脚

docs/index.md

Lines changed: 0 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -45,23 +45,6 @@ features:
4545
details: 支持 Cursor、Windsurf、Trae、Claude Desktop,动态工具注册,企业级安全策略
4646
---
4747

48-
- icon: ⚡
49-
title: 工作流引擎
50-
details: YAML/JSON 声明式工作流,顺序/并行/条件分支/循环执行,SQLite 状态持久化,完整错误处理
51-
52-
- icon: 🧩
53-
title: 插件系统
54-
details: 动态加载/卸载插件,钩子系统 (onInit, onTaskCreate 等),内置 PRD/工作流/任务模板
55-
56-
- icon: 🤝
57-
title: 多 Agent 协作
58-
details: 自主目标执行,AI 反思机制,多 Agent 消息传递和任务分发,短期/长期记忆系统
59-
60-
- icon: 🔌
61-
title: MCP 集成
62-
details: 支持 Cursor、Windsurf、Trae、Claude Desktop,动态工具注册,企业级安全策略
63-
---
64-
6548
## ⚡ 快速开始
6649

6750
### 安装

package-lock.json

Lines changed: 51 additions & 14 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)