Skip to content

Commit 0b4d9bc

Browse files
phodalphodal
committed
feat(sidebars): update sidebar structure by removing 'Architecture' category and adjusting 'Customize' and 'Development' categories for improved navigation
1 parent 621ad3f commit 0b4d9bc

File tree

4 files changed

+137
-186
lines changed

4 files changed

+137
-186
lines changed

‎docs/intro.mdx‎

Lines changed: 37 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -34,47 +34,6 @@ import useBaseUrl from '@docusaurus/useBaseUrl';
3434
> 🧙‍AutoDev: The AI-powered coding wizard with multilingual support 🌐, auto code generation 🏗️, and a helpful
3535
> bug-slaying assistant 🐞! Customizable prompts 🎨 and a magic Auto Dev/Testing/Document/Agent feature 🧪 included! 🚀
3636
37-
## Supported IDEs
38-
39-
- IntelliJ IDEA version: Android Studio, PyCharm, WebStorm, GoLand, RubyMine, AppCode and more.
40-
- VSCode Version: [https://github.com/unit-mesh/auto-dev-vscode](https://github.com/unit-mesh/auto-dev-vscode)
41-
42-
## AutoDev 2.0 Sketch
43-
44-
<iframe
45-
width="100%"
46-
height="315"
47-
src="https://www.youtube.com/embed/b1pO641-A54"
48-
title="AutoDev Sketch Demo"
49-
frameborder="0"
50-
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
51-
allowfullscreen
52-
/>
53-
54-
**AutoDev Sketch** is an IDE canvas feature provided by [Shire](https://github.com/phodal/shire), designed to simplify
55-
interactions and enhance the developer experience within the IDE.
56-
57-
| Sketch Name | Description | Screenshots |
58-
|-----------------------------|--------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------|
59-
| **Code Sketch** | Real-time code editor with syntax highlighting | ![](https://shire.run/images/shire-sketch-diff.png) |
60-
| **Diff Sketch** | Diff content comparison tool with patch handling | ![](https://shire.run/images/shire-sketch-diff-view.png) |
61-
| **Terminal Sketch** | Editable pop-up terminal interface and integration with other sketch, like frontend dev localhost in WebView | ![](https://shire.run/images/shire-sketch-terminal.png) |
62-
| **WebView Sketch** | HTML/React/Ionic mockup generator with WebView display | ![](https://shire.run/images/shire-sketch-webview.png) |
63-
| **OpenAPI Sketch`*`** | OpenAPI editor with bidirectional code-OpenAPI synchronization | ![](https://unitmesh.cc/auto-dev/sketch-openapi.png) |
64-
| **Dependency Sketch`*`** | Security-builtin vulnerable dependency checker | ![](https://unitmesh.cc/auto-dev/sketch-security-dependency.png) |
65-
| **Go Playground Sketch`*`** | Go Playground with bidirectional code preview/edit | ![](https://unitmesh.cc/auto-dev/sketch-go-playground.png) |
66-
| **Mermaid Sketch`*`** | Real-time flowchart preview/edit with bidirectional binding | ![](https://shire.run/images/shire-sketch-mermaid.png) |
67-
| **PlantUML Sketch`*`** | UML diagram editor with bidirectional code-diagram synchronization | ![](https://shire.run/images/shire-sketch-plantuml.png) |
68-
| **PlanSketch** | Display AutoDev Planner planning for resovling code issues | ![](https://unitmesh.cc/auto-dev/autodev-plan-sketch.png) |
69-
70-
`*` means requires additional plugin installation.
71-
72-
## Architecture
73-
74-
Here is the AutoDev architecture:
75-
76-
![AutoDev Architecture](/img/autodev-arch.svg)
77-
7837
## Feature Overview
7938

8039
![AutoDev Overview](/img/autodev-overview.svg)
@@ -114,3 +73,40 @@ Here is the AutoDev architecture:
11473
- Built-in LLM Fine-tune
11574
- [UnitEval](https://github.com/unit-mesh/unit-eval) evaluate llm result
11675
- [UnitGen](https://github.com/unit-mesh/unit-gen) generate code-llm fine-tune data.
76+
77+
78+
## AutoDev 2.0 Sketch
79+
80+
<iframe
81+
width="100%"
82+
height="315"
83+
src="https://www.youtube.com/embed/b1pO641-A54"
84+
title="AutoDev Sketch Demo"
85+
frameborder="0"
86+
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
87+
allowfullscreen
88+
/>
89+
90+
**AutoDev Sketch** is an IDE canvas feature provided by [Shire](https://github.com/phodal/shire), designed to simplify
91+
interactions and enhance the developer experience within the IDE.
92+
93+
| Sketch Name | Description | Screenshots |
94+
|-----------------------------|--------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------|
95+
| **Code Sketch** | Real-time code editor with syntax highlighting | ![](https://shire.run/images/shire-sketch-diff.png) |
96+
| **Diff Sketch** | Diff content comparison tool with patch handling | ![](https://shire.run/images/shire-sketch-diff-view.png) |
97+
| **Terminal Sketch** | Editable pop-up terminal interface and integration with other sketch, like frontend dev localhost in WebView | ![](https://shire.run/images/shire-sketch-terminal.png) |
98+
| **WebView Sketch** | HTML/React/Ionic mockup generator with WebView display | ![](https://shire.run/images/shire-sketch-webview.png) |
99+
| **OpenAPI Sketch`*`** | OpenAPI editor with bidirectional code-OpenAPI synchronization | ![](https://unitmesh.cc/auto-dev/sketch-openapi.png) |
100+
| **Dependency Sketch`*`** | Security-builtin vulnerable dependency checker | ![](https://unitmesh.cc/auto-dev/sketch-security-dependency.png) |
101+
| **Go Playground Sketch`*`** | Go Playground with bidirectional code preview/edit | ![](https://unitmesh.cc/auto-dev/sketch-go-playground.png) |
102+
| **Mermaid Sketch`*`** | Real-time flowchart preview/edit with bidirectional binding | ![](https://shire.run/images/shire-sketch-mermaid.png) |
103+
| **PlantUML Sketch`*`** | UML diagram editor with bidirectional code-diagram synchronization | ![](https://shire.run/images/shire-sketch-plantuml.png) |
104+
| **PlanSketch** | Display AutoDev Planner planning for resovling code issues | ![](https://unitmesh.cc/auto-dev/autodev-plan-sketch.png) |
105+
106+
`*` means requires additional plugin installation.
107+
108+
## Architecture
109+
110+
Here is the AutoDev architecture:
111+
112+
![AutoDev Architecture](/img/autodev-arch.svg)

‎docusaurus.config.ts‎

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -76,17 +76,6 @@ const config = {
7676
position: 'left',
7777
label: 'Docs',
7878
},
79-
{
80-
to: '/blog',
81-
label: 'Blog',
82-
position: 'left',
83-
},
84-
{
85-
type: 'docSidebar',
86-
sidebarId: 'architectureSidebar',
87-
position: 'left',
88-
label: 'Architecture',
89-
},
9079
{
9180
type: 'docSidebar',
9281
sidebarId: 'customizeSidebar',
@@ -99,6 +88,11 @@ const config = {
9988
position: 'left',
10089
label: 'Development',
10190
},
91+
{
92+
to: '/blog',
93+
label: 'Blog',
94+
position: 'left',
95+
},
10296
{
10397
type: 'localeDropdown',
10498
position: 'right',

‎i18n/zh-Hans/docusaurus-plugin-content-docs/current/intro.mdx‎

Lines changed: 66 additions & 84 deletions
Original file line numberDiff line numberDiff line change
@@ -7,63 +7,85 @@ import ThemedImage from '@theme/ThemedImage';
77
import useBaseUrl from '@docusaurus/useBaseUrl';
88

99
<ThemedImage
10-
alt="AutoDev 徽标"
11-
style={{ margin: '0 auto', display: 'block' }}
12-
sources={{
13-
light: useBaseUrl('/img/logo.svg'),
14-
dark: useBaseUrl('/img/logo-dark.svg'),
15-
}}
16-
width="160px"
17-
height="160px"
10+
alt="AutoDev 徽标"
11+
style={{ margin: '0 auto', display: 'block' }}
12+
sources={{
13+
light: useBaseUrl('/img/logo.svg'),
14+
dark: useBaseUrl('/img/logo-dark.svg'),
15+
}}
16+
width="160px"
17+
height="160px"
1818
/>
1919

20-
<h1 align="center">Intellij 平台版 AutoDev</h1>
20+
<h1 align="center">AutoDev for Intellij</h1>
2121

22-
<div align="center">
23-
<a href="https://codecov.io/gh/unit-mesh/auto-dev">
24-
<img src="https://codecov.io/gh/unit-mesh/auto-dev/graph/badge.svg?token=5RzcndjFPx"/>
25-
</a>
26-
<a href="https://github.com/unit-mesh/auto-dev/actions/workflows/build.yml">
27-
<img src="https://github.com/unit-mesh/auto-dev/actions/workflows/build.yml/badge.svg" alt="Build" />
28-
</a>
29-
<a href="https://github.com/unit-mesh/chocolate-factory">
30-
<img src="https://img.shields.io/badge/powered_by-chocolate_factory-blue?logo=kotlin&logoColor=fff" alt="Powered By" />
31-
</a>
32-
</div>
22+
## 功能概览
23+
24+
![AutoDev 功能概览](/img/autodev-overview.svg)
3325

34-
> 🧙‍AutoDev：这款 AI 驱动的编程神器支持多语言开发 🌐，具备自动代码生成能力 🏗️，并配备贴心的除虫助手 🐞！提供可定制提示词 🎨 和神奇的自动开发/测试/文档/智能体功能 🧪！🚀
26+
## 核心功能
3527

36-
## 支持的 IDE
28+
- **Sketch编码智能体**
29+
- 通过Sketch查看器驱动的智能化编码工作流
30+
- **自动开发模式**
31+
- AutoSQL（需数据库插件）：上下文感知的 SQL 生成
32+
- AutoPage（React）：上下文感知的网页生成
33+
- 自动测试：创建单元测试意图，自动运行并修复测试
34+
- 自动文档：自动生成技术文档
35+
- **智能协作模式**
36+
- 提供错误排查、代码解释、异常追踪、提交信息生成等功能
37+
- 模式匹配：根据代码上下文（如 Controller、Service 的 `import` 语句）推荐最佳代码
38+
- 关联代码：基于近期文件变更，通过相似代码块计算生成最优代码
39+
- **上下文感知对话**：支持选中代码的上下文感知对话
40+
- **高度可定制**
41+
- 自定义提示模板：支持 Controller、Service、Repository、Model 等模板定制
42+
- 自定义意图动作：可添加个性化意图操作
43+
- 自定义 LLM 服务器：通过 `设置` -> `工具` -> `AutoDev` 配置自有 LLM 服务
44+
- 动态文档定制：支持注解等动态文档的自定义
45+
- 团队智能：在代码库中定制团队级提示模板并进行分发
46+
- 提示词覆盖：支持覆盖 AutoDev 默认提示词
47+
- **开发生命周期支持**
48+
- 版本控制：生成/优化提交信息、发布说明等
49+
- 代码审查：自动生成代码审查内容
50+
- 智能重构：基于 AI 的重命名、代码异味检测、重构建议等功能
51+
- Dockerfile 生成：根据项目特征生成 Dockerfile
52+
- CI/CD 配置：根据构建工具生成 CI/CD 配置文件（如 `.github/workflows/build.yml`）
53+
- 终端集成：在终端工具窗口中使用自定义输入生成 shell/命令
54+
- **自定义 AI 智能体**
55+
- 可执行智能体语言：DevIns
56+
- 自定义 AI 智能体：支持集成自有 AI 智能体到 AutoDev
57+
- **模型支持**
58+
- 内置 LLM 微调功能
59+
- [UnitEval](https://github.com/unit-mesh/unit-eval) 大模型结果评估
60+
- [UnitGen](https://github.com/unit-mesh/unit-gen) 代码大模型微调数据生成
3761

38-
- IntelliJ IDEA 系列：Android Studio、PyCharm、WebStorm、GoLand、RubyMine、AppCode 等
39-
- VSCode 版本：[https://github.com/unit-mesh/auto-dev-vscode](https://github.com/unit-mesh/auto-dev-vscode)
4062

41-
## AutoDev 2.0 Sketch功能
63+
## AutoDev 2.0 Sketch
4264

4365
<iframe
44-
width="100%"
45-
height="315"
46-
src="https://www.youtube.com/embed/b1pO641-A54"
47-
title="AutoDev Sketch功能演示"
48-
frameborder="0"
49-
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
50-
allowfullscreen
66+
width="100%"
67+
height="315"
68+
src="https://www.youtube.com/embed/b1pO641-A54"
69+
title="AutoDev Sketch功能演示"
70+
frameborder="0"
71+
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
72+
allowfullscreen
5173
/>
5274

5375
**AutoDev Sketch**是由 [Shire](https://github.com/phodal/shire) 提供的 IDE 画布功能，旨在简化交互并提升 IDE 内的开发体验。
5476

55-
| Sketch名称 | 描述 | 截图 |
56-
|-------------------------|------------------------------------------------------------------------------------------------------|----------------------------------------------------------|
57-
| **代码Sketch** | 实时代码编辑器，支持语法高亮 | ![](https://shire.run/images/shire-sketch-diff.png) |
58-
| **差异对比Sketch** | 支持补丁处理的差异内容对比工具 | ![](https://shire.run/images/shire-sketch-diff-view.png) |
59-
| **终端Sketch** | 可编辑的弹出式终端界面，支持与其他Sketch集成（如前端开发的 WebView 本地服务器） | ![](https://shire.run/images/shire-sketch-terminal.png) |
60-
| **WebView Sketch** | 支持 HTML/React/Ionic 原型生成的 WebView 展示 | ![](https://shire.run/images/shire-sketch-webview.png) |
61-
| **OpenAPI Sketch`*`** | 支持代码与 OpenAPI 双向同步的 OpenAPI 编辑器 | ![](https://unitmesh.cc/auto-dev/sketch-openapi.png) |
62-
| **依赖分析Sketch`*`** | 内置安全漏洞检测的依赖检查工具 | ![](https://unitmesh.cc/auto-dev/sketch-security-dependency.png) |
63-
| **Go 实验场Sketch`*`** | 支持代码双向预览/编辑的 Go Playground | ![](https://unitmesh.cc/auto-dev/sketch-go-playground.png)|
64-
| **Mermaid 流程图Sketch`*`** | 支持双向绑定的实时流程图预览/编辑 | ![](https://shire.run/images/shire-sketch-mermaid.png) |
65-
| **PlantUML Sketch`*`** | 支持代码与 UML 图双向同步的 UML 编辑器 | ![](https://shire.run/images/shire-sketch-plantuml.png) |
66-
| **计划Sketch** | 展示 AutoDev 规划器解决代码问题的方案 | ![](https://unitmesh.cc/auto-dev/autodev-plan-sketch.png) |
77+
| Sketch名称 | 描述 | 截图 |
78+
|--------------------------|-------------------------------------------------|------------------------------------------------------------------|
79+
| **代码Sketch** | 实时代码编辑器，支持语法高亮 | ![](https://shire.run/images/shire-sketch-diff.png) |
80+
| **差异对比Sketch** | 支持补丁处理的差异内容对比工具 | ![](https://shire.run/images/shire-sketch-diff-view.png) |
81+
| **终端Sketch** | 可编辑的弹出式终端界面，支持与其他Sketch集成（如前端开发的 WebView 本地服务器） | ![](https://shire.run/images/shire-sketch-terminal.png) |
82+
| **WebView Sketch** | 支持 HTML/React/Ionic 原型生成的 WebView 展示 | ![](https://shire.run/images/shire-sketch-webview.png) |
83+
| **OpenAPI Sketch`*`** | 支持代码与 OpenAPI 双向同步的 OpenAPI 编辑器 | ![](https://unitmesh.cc/auto-dev/sketch-openapi.png) |
84+
| **依赖分析Sketch`*`** | 内置安全漏洞检测的依赖检查工具 | ![](https://unitmesh.cc/auto-dev/sketch-security-dependency.png) |
85+
| **Go 实验场Sketch`*`** | 支持代码双向预览/编辑的 Go Playground | ![](https://unitmesh.cc/auto-dev/sketch-go-playground.png) |
86+
| **Mermaid 流程图Sketch`*`** | 支持双向绑定的实时流程图预览/编辑 | ![](https://shire.run/images/shire-sketch-mermaid.png) |
87+
| **PlantUML Sketch`*`** | 支持代码与 UML 图双向同步的 UML 编辑器 | ![](https://shire.run/images/shire-sketch-plantuml.png) |
88+
| **计划Sketch** | 展示 AutoDev 规划器解决代码问题的方案 | ![](https://unitmesh.cc/auto-dev/autodev-plan-sketch.png) |
6789

6890
`*` 表示需要额外安装插件
6991

@@ -72,43 +94,3 @@ import useBaseUrl from '@docusaurus/useBaseUrl';
7294
AutoDev 系统架构图：
7395

7496
![AutoDev 架构图](/img/autodev-arch.svg)
75-
76-
## 功能概览
77-
78-
![AutoDev 功能概览](/img/autodev-overview.svg)
79-
80-
## 核心功能
81-
82-
- **Sketch编码智能体**
83-
- 通过Sketch查看器驱动的智能化编码工作流
84-
- **自动开发模式**
85-
- AutoSQL（需数据库插件）：上下文感知的 SQL 生成
86-
- AutoPage（React）：上下文感知的网页生成
87-
- 自动测试：创建单元测试意图，自动运行并修复测试
88-
- 自动文档：自动生成技术文档
89-
- **智能协作模式**
90-
- 提供错误排查、代码解释、异常追踪、提交信息生成等功能
91-
- 模式匹配：根据代码上下文（如 Controller、Service 的 `import` 语句）推荐最佳代码
92-
- 关联代码：基于近期文件变更，通过相似代码块计算生成最优代码
93-
- **上下文感知对话**：支持选中代码的上下文感知对话
94-
- **高度可定制**
95-
- 自定义提示模板：支持 Controller、Service、Repository、Model 等模板定制
96-
- 自定义意图动作：可添加个性化意图操作
97-
- 自定义 LLM 服务器：通过 `设置` -> `工具` -> `AutoDev` 配置自有 LLM 服务
98-
- 动态文档定制：支持注解等动态文档的自定义
99-
- 团队智能：在代码库中定制团队级提示模板并进行分发
100-
- 提示词覆盖：支持覆盖 AutoDev 默认提示词
101-
- **开发生命周期支持**
102-
- 版本控制：生成/优化提交信息、发布说明等
103-
- 代码审查：自动生成代码审查内容
104-
- 智能重构：基于 AI 的重命名、代码异味检测、重构建议等功能
105-
- Dockerfile 生成：根据项目特征生成 Dockerfile
106-
- CI/CD 配置：根据构建工具生成 CI/CD 配置文件（如 `.github/workflows/build.yml`）
107-
- 终端集成：在终端工具窗口中使用自定义输入生成 shell/命令
108-
- **自定义 AI 智能体**
109-
- 可执行智能体语言：DevIns
110-
- 自定义 AI 智能体：支持集成自有 AI 智能体到 AutoDev
111-
- **模型支持**
112-
- 内置 LLM 微调功能
113-
- [UnitEval](https://github.com/unit-mesh/unit-eval) 大模型结果评估
114-
- [UnitGen](https://github.com/unit-mesh/unit-gen) 代码大模型微调数据生成

0 commit comments

Comments
 (0)