Skip to content

Commit fb9ff76

Browse files
committed
docs: update install and ml-run guides with local assets
- Replace external Imgur links with local images/videos in ml-run.md - Add video controls for ml_init.mp4 configuration guide - Update install.md with high-fidelity terminal screenshots for env setup and docker composition - Add new assets to user-guide/assets and install/assets - Update FAQ.md with local error images
1 parent b25584a commit fb9ff76

15 files changed

+17
-47
lines changed

FAQ.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Alternatively, you can try clearing your browser's cache specifically for the Ev
3434

3535
If you are running EvOC via a **local installation** (using Docker, etc.), you might see error messages appear in the terminal window where you launched the EvOC services. These errors often mention failures to connect to or fetch required microservices. The application UI might fail to load certain parts or become unresponsive. An example might look like this:
3636

37-
![Terminal output showing error messages related to fetching or connecting to microservices](https://i.imgur.com/1x4NVoa.png)
37+
![Terminal output showing error messages related to fetching or connecting to microservices](./user-guide/assets/microservices_error.png)
3838

3939
### Cause
4040

install/assets/docker_command.png

19.7 KB
Loading

install/assets/docker_compose.png

36.9 KB
Loading

install/assets/docker_pulling.png

38 KB
Loading

install/assets/env_content.png

83.5 KB
Loading

install/assets/env_creation.png

35.8 KB
Loading

install/install.md

Lines changed: 11 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ Navigate into the project folder and create an `.env` file:
2323
touch .env
2424
```
2525

26+
![env-creation](./assets/env_creation.png)
2627

2728
## Paste Environment Variables
2829

@@ -46,10 +47,11 @@ MAILER_PASSWORD = <mailer_pass>
4647
FRONTEND_URL = http://localhost:3000
4748
AUTH_HTTP_PORT = 5000
4849
AUTH_GRPC_PORT = 5001
49-
REDIS_URL= redis://host.docker.internal:6379/0
50+
5051
RUNNER_CONTROLLER_HTTP_PORT = 5002
5152
AUTH_GRPC_ADDRESS = host.docker.internal:5001
5253
54+
5355
NEXT_PUBLIC_BACKEND_BASE_URL=http://localhost:5002
5456
NEXT_PUBLIC_AUTH_BASE_URL=http://localhost:5000
5557
NEXT_PUBLIC_MINIO_BASE_URL=http://localhost:9000
@@ -59,45 +61,7 @@ NEXT_PUBLIC_AI=false
5961
GOOGLE_GENERATIVE_AI_API_KEY=<YOUR_GEMINI_API_KEY>
6062
```
6163

62-
63-
64-
## Obtain a Gemini API Key (Optional – Required for AI Features)
65-
66-
EvOC supports AI-powered features using Google’s **Gemini API**.
67-
To enable these features, you must obtain a Gemini API key and add it to your `.env` file.
68-
69-
### Steps to get a Gemini API key
70-
71-
1. Visit **Google AI Studio**:
72-
https://aistudio.google.com/
73-
74-
2. Sign in with your Google account.
75-
76-
3. Click **Get API key****Create API key**.
77-
78-
4. Select an existing Google Cloud project or create a new one.
79-
80-
5. Copy the generated API key.
81-
82-
### Enable AI features
83-
84-
In your `.env` file:
85-
```env
86-
NEXT_PUBLIC_AI=true
87-
GOOGLE_GENERATIVE_AI_API_KEY=<YOUR_GEMINI_API_KEY>
88-
```
89-
90-
91-
If you do not want AI features, keep:
92-
```
93-
NEXT_PUBLIC_AI=false
94-
```
95-
96-
::: warning
97-
Do not commit your API key to version control.
98-
The .env file should remain private and untracked.
99-
:::
100-
64+
![env-content](./assets/env_content.png)
10165

10266
## Run Services
10367

@@ -109,13 +73,19 @@ docker compose up -d
10973

11074
Alternatively, click the `Run All Services` button at the start of the `.yml` file (if your IDE supports it):
11175

76+
![docker-command](./assets/docker_command.png)
77+
78+
The following services will start installing:
11279

80+
![docker-start](./assets/docker_pulling.png)
11381

82+
If the following statements are displayed after installation, you have successfully set up the backend:
11483

84+
![docker-complete](./assets/docker_compose.png)
11585

11686
## Accessing EvOC
11787

118-
Once the services are up and running, you can access EvOC at [http://localhost:3000](http://localhost:3000).
88+
Once the services are up and running, you can access the EvOC backend at [http://localhost:3000](http://localhost:3000).
11989

12090
## Clean Up
12191

-105 KB
Loading
75.1 KB
Loading

user-guide/assets/ml_code_gen.gif

5.53 MB
Loading

0 commit comments

Comments
 (0)