Skip to content

Commit a462f8e

Browse files
committed
docs: update documentation for chat-with-code and works-with-review features
The documentation for the chat-with-code and works-with-review features has been updated to include clearer instructions and examples.
1 parent 18abafc commit a462f8e

File tree

4 files changed

+10
-7
lines changed

4 files changed

+10
-7
lines changed

docs/devins/quick-start.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,18 +32,20 @@ ScreenShot
3232
- `/commit`: commit changes to git
3333
- `/symbol`: get child by symbol, like get Class by package name, format: `java.lang.String#length`,
3434
example: `<package>.<class>#<method>`
35-
- `/shell`: run shell command, like `ls`, `pwd`, etc.
36-
- '/browse': browse web page, like `https://ide.unitmesh.cc`
35+
- `/shell`: run shell command or shell script, like `ls`, `pwd`, etc.
36+
- `/browse`: browse web page, like `https://ide.unitmesh.cc`
3737

3838
### File Command
3939

4040
Read file content:
4141

4242
Explain code /file:src/main/java/com/example/Controller.java
4343

44+
will call LLM to handle it.
45+
4446
### Write Command
4547

46-
write file content:
48+
write content to file:
4749

4850
/write:src/main/java/com/example/Controller.java#L1-L12
4951
```java
@@ -60,6 +62,8 @@ Read git change by git revision:
6062

6163
Explain code /rev:HEAD~1
6264

65+
will call LLM to handle it.
66+
6367
### Run Command
6468

6569
Run file:
@@ -105,4 +109,4 @@ Browse web page:
105109

106110
/browse:https://ide.unitmesh.cc
107111

108-
The will be text inside body from web page.
112+
It will be text inside the body from web page.

docs/features/chat-with-code.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@ permalink: /features/chat-width-code
1919

2020
## Write test for this
2121

22-
2322
## Generate test data (APIs)
2423

2524
support language: Java

docs/features/works-with-git.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ permalink: /features/works-with-git
88

99
## Generate commit messages
1010

11-
<img src="https://unitmesh.cc/auto-dev/gen-commit.png" alt="gen commit" width="400px"/>
11+
<img src="https://unitmesh.cc/auto-dev/gen-commit.png" alt="Gen commit Msg" width="400px"/>
1212

1313
## Generate Release Note
1414

docs/features/works-with-review.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ nav_order: 9
66
permalink: /features/code-review
77
---
88

9-
1. select commit in Git panel, and right-click to show the context-menu
9+
1. select commit in the Git panel (`Cmd` + `9`), and right-click to show the context-menu
1010

1111
<img src="https://unitmesh.cc/auto-dev/works-with-git.png" alt="Code Review" width="400px"/>
1212

0 commit comments

Comments
 (0)