Skip to content

Commit 9d39866

Browse files
phodalphodal
committed
docs: update usage documentation with full landscape.
1 parent f4a4b06 commit 9d39866

File tree

5 files changed

+37
-34
lines changed

5 files changed

+37
-34
lines changed

‎README.md

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -55,40 +55,39 @@ Here is the AutoDev architecture:
5555
Features:
5656

5757
- Languages support: Java, Kotlin, JavaScript/TypeScript, Rust, Python, Golang, C/C++/OC, or others...
58-
- Auto development mode.
59-
- AutoCRUD(Spring framework）. With DevTi Protocol (like `devti://story/github/1102`) will auto
58+
- Auto development mode
59+
- AutoCRUD (Spring framework）. With DevTi Protocol (like `devti://story/github/1102`) will auto
6060
generate Model-Controller-Service-Repository code.
61-
- AutoSQL. Context-aware SQL generation.
61+
- AutoSQL (required Database plugin). Context-aware SQL generation.
6262
- AutoPage (React). Context-aware Web Page generation.
63-
- AutoArkUI (Mobile UI framework). Auto generate HarmonyOS ArkUI code.
63+
- AutoArkUI (HarmonyOS). Auto generate HarmonyOS ArkUI code.
6464
- AutoTesting. create unit test intention, auto run unit test and try to fix test.
6565
- AutoDocument. Auto generate document.
6666
- Copilot mode
6767
- AutoDev will help you find bug, explain code, trace exception, generate commits, and more.
6868
- Pattern specific. Based on your code context like (Controller, Service `import`), AutoDev will suggest the best
6969
code to you.
7070
- Related code. Based on recent file changes, AutoDev will call calculate similar chunk to generate the best code.
71-
- Chat mode
72-
- Chat with AI.
73-
- Chat with selection code.
74-
- Chat with code context-aware (To be implemented).
71+
- Chat with AI. Chat with selection code and context-aware code.
7572
- Customize.
7673
- Custom specification of prompt. For example, Controller, Service, Repository, Model, etc.
7774
- Custom intention action. You can add your own intention action.
7875
- Custom LLM Server. You can customize your LLM Server in `Settings` -> `Tools` -> `AutoDev`
79-
- Custom Living documentation.
80-
- Team prompts. Customize your team prompts in codebase, and distribute to your team.
76+
- Custom Living documentation. Customize your own living documentation, like annotation.
77+
- Team AI. Customize your team prompts in codebase, and distribute to your team.
8178
- Prompt override. You can override AutoDev's prompt in your codebase.
8279
- SDLC
83-
- CI/CD config. Based on build tool, generate CI/CD config file, like `.github/workflows/build.yml`.
80+
- VCS. Generate/improve commit message, release note, and more.
81+
- Code Review. Generate code-review content.
82+
- Smart Refactoring. AI based Rename, refactoring with code smell, refactoring suggetion and more.
8483
- Dockerfile. Based on your project, generate Dockerfile.
84+
- CI/CD config. Based on build tool, generate CI/CD config file, like `.github/workflows/build.yml`.
8585
- Terminal. In Terminal ToolWindow, you can use custom input to generate shell/command
86-
- VCS. Based on your code changes, generate commit message.
87-
- Code Review. Based on your code changes, generate code review message.
88-
- AI Agent
86+
- Custom AI Agent
8987
- Executable AI Agent language: DevIns.
9088
- Custom AI Agent. You can integrate your own AI Agent into AutoDev.
91-
- Built-in LLM Fine-tune
89+
- Model
90+
- Built-in LLM Fine-tune
9291
- [UnitEval](https://github.com/unit-mesh/unit-eval) evaluate llm result
9392
- [UnitGen](https://github.com/unit-mesh/unit-gen) generate code-llm fine-tune data.
9493

‎docs/autodev-overview.svg

Lines changed: 3 additions & 3 deletions
Loading

‎docs/features/shell-suggest.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,9 @@ [email protected]
1313

1414
In Terminal, we provide a feature to generate shell script by LLM.
1515

16+
![Shell Suggest](https://unitmesh.cc/auto-dev/autodev-shell-suggest.png)
17+
18+
1619
## Customize
1720

1821
### Default context
@@ -29,3 +32,5 @@ data class ShellSuggestContext(
2932
)
3033
```
3134

35+
### Prompt output example
36+

‎docs/index.md

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -46,40 +46,39 @@ Here is the AutoDev architecture:
4646
Features:
4747

4848
- Languages support: Java, Kotlin, JavaScript/TypeScript, Rust, Python, Golang, C/C++/OC, or others...
49-
- Auto development mode.
50-
- AutoCRUD(Spring framework）. With DevTi Protocol (like `devti://story/github/1102`) will auto
49+
- Auto development mode
50+
- AutoCRUD (Spring framework）. With DevTi Protocol (like `devti://story/github/1102`) will auto
5151
generate Model-Controller-Service-Repository code.
52-
- AutoSQL. Context-aware SQL generation.
52+
- AutoSQL (required Database plugin). Context-aware SQL generation.
5353
- AutoPage (React). Context-aware Web Page generation.
54-
- AutoArkUI (Mobile UI framework). Auto generate HarmonyOS ArkUI code.
54+
- AutoArkUI (HarmonyOS). Auto generate HarmonyOS ArkUI code.
5555
- AutoTesting. create unit test intention, auto run unit test and try to fix test.
5656
- AutoDocument. Auto generate document.
5757
- Copilot mode
5858
- AutoDev will help you find bug, explain code, trace exception, generate commits, and more.
5959
- Pattern specific. Based on your code context like (Controller, Service `import`), AutoDev will suggest the best
6060
code to you.
6161
- Related code. Based on recent file changes, AutoDev will call calculate similar chunk to generate the best code.
62-
- Chat mode
63-
- Chat with AI.
64-
- Chat with selection code.
65-
- Chat with code context-aware (To be implemented).
62+
- Chat with AI. Chat with selection code and context-aware code.
6663
- Customize.
6764
- Custom specification of prompt. For example, Controller, Service, Repository, Model, etc.
6865
- Custom intention action. You can add your own intention action.
6966
- Custom LLM Server. You can customize your LLM Server in `Settings` -> `Tools` -> `AutoDev`
70-
- Custom Living documentation.
71-
- Team prompts. Customize your team prompts in codebase, and distribute to your team.
67+
- Custom Living documentation. Customize your own living documentation, like annotation.
68+
- Team AI. Customize your team prompts in codebase, and distribute to your team.
7269
- Prompt override. You can override AutoDev's prompt in your codebase.
7370
- SDLC
74-
- CI/CD config. Based on build tool, generate CI/CD config file, like `.github/workflows/build.yml`.
71+
- VCS. Generate/improve commit message, release note, and more.
72+
- Code Review. Generate code-review content.
73+
- Smart Refactoring. AI based Rename, refactoring with code smell, refactoring suggetion and more.
7574
- Dockerfile. Based on your project, generate Dockerfile.
75+
- CI/CD config. Based on build tool, generate CI/CD config file, like `.github/workflows/build.yml`.
7676
- Terminal. In Terminal ToolWindow, you can use custom input to generate shell/command
77-
- VCS. Based on your code changes, generate commit message.
78-
- Code Review. Based on your code changes, generate code review message.
79-
- AI Agent
77+
- Custom AI Agent
8078
- Executable AI Agent language: DevIns.
8179
- Custom AI Agent. You can integrate your own AI Agent into AutoDev.
82-
- Built-in LLM Fine-tune
80+
- Model
81+
- Built-in LLM Fine-tune
8382
- [UnitEval](https://github.com/unit-mesh/unit-eval) evaluate llm result
8483
- [UnitGen](https://github.com/unit-mesh/unit-gen) generate code-llm fine-tune data.
8584

‎exts/devins-lang/src/main/resources/agent/toolExamples/file.devin

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
/file:.github/dependabot.yml
1+
/file:.github/dependabot.yml#L1C1-L2C12

0 commit comments

Comments
 (0)