Skip to content

Commit 655333d

Browse files
author
Omar Hughes
committed
improve readme doc and use docker for local docs
1 parent 8b8d414 commit 655333d

File tree

3 files changed

+12
-13
lines changed

3 files changed

+12
-13
lines changed

README.md

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -69,18 +69,13 @@ To use ECA, you need to configure at least one model with your API key. See the
6969

7070
```json
7171
{
72-
"openaiApiKey": "your-openai-api-key-here"
73-
}
74-
```
75-
76-
Or for Anthropic:
77-
78-
```json
79-
{
72+
"openaiApiKey": "your-openai-api-key-here",
8073
"anthropicApiKey": "your-anthropic-api-key-here"
8174
}
8275
```
8376

77+
**Note**: For other providers or custom models, see the [custom providers documentation](./models#setting-up-a-custom-provider).
78+
8479
### 3. Start chatting
8580

8681
Once your model is configured, you can start using ECA's chat interface in your editor to ask questions, review code, and work together on your project.

bb.edn

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,4 @@
1818
get-last-changelog-entry make/get-last-changelog-entry
1919
integration-test make/integration-test
2020

21-
docs-serve {:doc "Create symlinks for README.md and CHANGELOG.md in docs/ and serve with mkdocs"
22-
:task (do
23-
(shell "ln -sf ../README.md docs/README.md")
24-
(shell "ln -sf ../CHANGELOG.md docs/CHANGELOG.md")
25-
(shell "mkdocs serve -a 0.0.0.0:8005"))}}}
21+
docs make/local-webpage}}

scripts/make.clj

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,3 +106,11 @@
106106
1 (entrypoint/run-all (str (first eca-bins-found)))
107107
(throw (ex-info "More than one eca executables found. Can only work with one."
108108
{:bin-found eca-bins-found})))))
109+
110+
(defn local-webpage []
111+
(let [files ["CHANGELOG.md" "README.md"]]
112+
(doseq [f files]
113+
(fs/copy f "docs" {:replace-existing true}))
114+
(fs/copy-tree "images" "docs" {:replace-existing true})
115+
(p/shell "docker login docker.pkg.github.com")
116+
(p/shell (str "docker run --rm -it -p 8000:8000 -v " (fs/cwd) ":/docs ghcr.io/editor-code-assistant/docs-image/docs-image"))))

0 commit comments

Comments
 (0)