Skip to content

Commit f0085a3

Browse files
committed
docs(docs): add Auto Document feature
Add the Auto Document feature to AutoDev, which automatically generates documentation. This feature enhances the existing Auto Dev/Testing feature and allows for easier documentation generation.
1 parent 17476d2 commit f0085a3

File tree

2 files changed

+12
-7
lines changed

2 files changed

+12
-7
lines changed

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
</p>
2222

2323
> 🧙‍AutoDev: The AI-powered coding wizard with multilingual support 🌐, auto code generation 🏗️, and a helpful
24-
> bug-slaying assistant 🐞! Customizable prompts 🎨 and a magic Auto Dev/Testing feature 🧪 included! 🚀
24+
> bug-slaying assistant 🐞! Customizable prompts 🎨 and a magic Auto Dev/Testing/Document feature 🧪 included! 🚀
2525
2626
[Quick Start →](https://ide.unitmesh.cc/quick-start)
2727

@@ -31,29 +31,32 @@ AutoDev Overview:
3131
<img src="docs/autodev-overview.svg" width="100%" height="100%" alt="Overview" />
3232
</p>
3333

34+
3435
Features:
3536

36-
- Languages support: Java, Kotlin, JavaScript/TypeScript, Rust, Python, Golang, or others...
37+
- Languages support: Java, Kotlin, JavaScript/TypeScript, Rust, Python, Golang, or others...
3738
- Auto development mode.
3839
- With DevTi Protocol (like `devti://story/github/1102`) will auto generate
3940
Model-Controller-Service-Repository code.
4041
- AutoCRUD mode (Java/Kotlin Language only). Auto generate CRUD code.
4142
- Auto Testing. create unit test intention, auto run unit test and try to fix test.
43+
- Auto Document. Auto generate document.
4244
- Copilot mode
4345
- Pattern specific.Based on your code context like (Controller, Service `import`), AutoDev will suggest you the best
4446
code.
45-
- Related code. Based on recent file changes, AutoDev will call calculate similar chunk to generate best code.
47+
- Related code. Based on recent file changes, AutoDev will call calculate similar chunk to generate the best code.
4648
- AutoDev will help you find bug, explain code, trace exception, generate commits, and more.
4749
- Chat mode
4850
- Chat with AI.
4951
- Chat with selection code.
52+
- Chat with code context-aware (To be implemented).
5053
- Customize.
5154
- Custom specification of prompt.
5255
- Custom intention action. You can add your own intention action.
5356
- Custom LLM Server. You can customize your LLM Server in `Settings` -> `Tools` -> `AutoDev`
5457
- Custom Living documentation.
5558
- Team prompts. Customize your team prompts in codebase, and distribute to your team.
56-
- Custom Quick Action. You can add your own quick action.
59+
- Prompt override. You can override AutoDev's prompt in your codebase.
5760
- Miscellaneous
5861
- CI/CD support. AutoDev will auto generate CI/CD config file.
5962
- Dockerfile support. AutoDev will auto generate Dockerfile.

docs/index.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ permalink: /
2929
</p>
3030

3131
> 🧙‍AutoDev: The AI-powered coding wizard with multilingual support 🌐, auto code generation 🏗️, and a helpful
32-
> bug-slaying assistant 🐞! Customizable prompts 🎨 and a magic Auto Dev/Testing feature 🧪 included! 🚀
32+
> bug-slaying assistant 🐞! Customizable prompts 🎨 and a magic Auto Dev/Testing/Document feature 🧪 included! 🚀
3333
3434
AutoDev Overview:
3535

@@ -39,12 +39,13 @@ AutoDev Overview:
3939

4040
Features:
4141

42-
- Languages support: Java, Kotlin, JavaScript/TypeScript, Rust, Python, Golang, or others...
42+
- Languages support: Java, Kotlin, JavaScript/TypeScript, Rust, Python, Golang, or others...
4343
- Auto development mode.
4444
- With DevTi Protocol (like `devti://story/github/1102`) will auto generate
4545
Model-Controller-Service-Repository code.
4646
- AutoCRUD mode (Java/Kotlin Language only). Auto generate CRUD code.
4747
- Auto Testing. create unit test intention, auto run unit test and try to fix test.
48+
- Auto Document. Auto generate document.
4849
- Copilot mode
4950
- Pattern specific.Based on your code context like (Controller, Service `import`), AutoDev will suggest you the best
5051
code.
@@ -53,12 +54,14 @@ Features:
5354
- Chat mode
5455
- Chat with AI.
5556
- Chat with selection code.
57+
- Chat with code context-aware (To be implemented).
5658
- Customize.
5759
- Custom specification of prompt.
5860
- Custom intention action. You can add your own intention action.
5961
- Custom LLM Server. You can customize your LLM Server in `Settings` -> `Tools` -> `AutoDev`
6062
- Custom Living documentation.
6163
- Team prompts. Customize your team prompts in codebase, and distribute to your team.
64+
- Prompt override. You can override AutoDev's prompt in your codebase.
6265
- Miscellaneous
6366
- CI/CD support. AutoDev will auto generate CI/CD config file.
6467
- Dockerfile support. AutoDev will auto generate Dockerfile.
@@ -68,7 +71,6 @@ Features:
6871

6972
AutoDev fine-tune models:
7073

71-
7274
| name | model download (HuggingFace) | finetune Notebook | model download (OpenBayes) |
7375
|---------------|-----------------------------------------------------------------|--------------------------------------|-------------------------------------------------------------------------------------|
7476
| DeepSeek 6.7B | [AutoDev Coder](https://huggingface.co/unit-mesh/autodev-coder) | [finetune.ipynb](finetunes/deepseek) | [AutoDev Coder](https://openbayes.com/console/phodal/models/rCmer1KQSgp/9/overview) |

0 commit comments

Comments
 (0)