Skip to content

Commit 863561f

Browse files
committed
docs
1 parent caf0763 commit 863561f

File tree

3 files changed

+17
-4
lines changed

3 files changed

+17
-4
lines changed

README.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ _Demo using [eca-vscode](https://github.com/editor-code-assistant/eca-vscode)_
2121
<a href="https://eca.dev/configuration"><strong>configuration</strong></a> •
2222
<a href="https://eca.dev/models"><strong>models</strong></a> •
2323
<a href="https://eca.dev/protocol"><strong>protocol</strong></a>
24+
<a href="https://eca.dev/troubleshooting"><strong>troubleshooting</strong></a>
2425
</p>
2526
<hr>
2627

@@ -90,10 +91,6 @@ Editors spawn the server via `eca server` and communicate via stdin/stdout, simi
9091

9192
Check the planned work [here](https://github.com/orgs/editor-code-assistant/projects/1).
9293

93-
## Troubleshooting
94-
95-
You can start eca with `--log-level debug` or `--verbose` which should log helpful information to stderr buffer like what is being sent to LLMs or what ECA is responding to editors.
96-
9794
## Contributing
9895

9996
Contributions are very welcome, please open an issue for discussion or a pull request.

docs/troubleshooting.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Troubleshooting
2+
3+
## Server logs
4+
5+
ECA works with clients (editors) sending and receiving messages to server, a process, you can start server with `--log-level debug` or `--verbose` which should log helpful information to `stderr` buffer like what is being sent to LLMs or what ECA is responding to editors, all supported editors have options to set the __server args___ to help with that.
6+
7+
8+
## Doctor command
9+
10+
`/doctor` command should log useful information to debug model used, server version, env vars and more.
11+
12+
13+
## Ask for help
14+
15+
You can ask for help via chat [here](https://clojurians.slack.com/archives/C093426FPUG)

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ nav:
1212
- Models: models.md
1313
- Development: development.md
1414
- Protocol: protocol.md
15+
- Troubleshooting: troubleshooting.md
1516
- Features: features.md
1617
- Installation: installation.md
1718
- Models: models.md

0 commit comments

Comments
 (0)