Skip to content

Commit b25584a

Browse files
committed
docs: restore missing images and fix broken links in user guides
- Replaced broken Imgur links with local assets in auth.md, pso-run.md, de-run.md, ml-run.md, gp-run.md, ea-run.md, and FAQ.md. - Added necessary image and video assets to user-guide/assets and install/assets. - Fixed video rendering in pso-run.md by using HTML video tags. - Updated installation guides (install.md, env-setup.md) with correct visuals.
1 parent 280cb2d commit b25584a

34 files changed

+41
-52
lines changed

.DS_Store

8 KB
Binary file not shown.

.vitepress/.DS_Store

6 KB
Binary file not shown.

FAQ.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Encountering problems? Here are solutions for some common issues you might face
1313

1414
After accessing the EvOC web application and clicking the **`Get Started`** or **`Sign Up`** button on the homepage, you immediately see an error message, potentially similar to this:
1515

16-
![Error message appearing shortly after clicking Get Started, possibly related to loading resources](https://i.imgur.com/XCiKGpB.png)
16+
![Error message appearing shortly after clicking Get Started, possibly related to loading resources](./user-guide/assets/error_message.png)
1717

1818
### Cause
1919

install/.DS_Store

6 KB
Binary file not shown.

install/assets/config.jpeg

180 KB
Loading
3.92 MB
Loading

install/assets/vscode.gif

1.06 MB
Loading

install/env-setup.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@ description: Step-by-step guide to set up the environment for running EvOC local
77

88
## Docker Desktop
99

10-
1. Install **Docker Desktop** from the [official website](https://www.docker.com/get-started/).
10+
1. Install **Docker Desktop** from the [official website](./assets/docker_installation.gif).
1111
2. Open **Docker Desktop** and update it to the latest version via **Settings → Software Updates**.
1212

13-
![Docker Home page](https://i.imgur.com/5DU1pUZ.png)
13+
![Docker Home page](./assets/docker_installation.gif)
1414

1515
## Create a GMail Mailer Account
1616

@@ -24,6 +24,6 @@ description: Step-by-step guide to set up the environment for running EvOC local
2424
1. Download and install [Visual Studio Code](https://code.visualstudio.com/).
2525
2. Install the **Docker extension** from Microsoft to manage services inside Docker using `.yml` files.
2626

27-
![VS Code Docker Extension](https://i.imgur.com/4wMJyh6.png)
27+
![VS Code Docker Extension](./assets/vscode.gif)
2828

2929
<!-- TODO: Docs about getting a free Gemini API key for AI Features. -->

install/install.md

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

26-
![env-creation](https://i.imgur.com/pETnAVR.png)
2726

2827
## Paste Environment Variables
2928

@@ -60,7 +59,6 @@ NEXT_PUBLIC_AI=false
6059
GOOGLE_GENERATIVE_AI_API_KEY=<YOUR_GEMINI_API_KEY>
6160
```
6261

63-
![env-content](https://i.imgur.com/1uGj3rU.png)
6462

6563

6664
## Obtain a Gemini API Key (Optional – Required for AI Features)
@@ -111,15 +109,9 @@ docker compose up -d
111109

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

114-
![extension-in-action](https://i.imgur.com/uR0PH3J.png)
115112

116-
The following services will start installing:
117113

118-
![docker-start](https://i.imgur.com/4UsiBr7.png)
119114

120-
If the following statements are displayed after installation, you have successfully set up the backend:
121-
122-
![docker-complete](https://i.imgur.com/eQ3oz2Y.png)
123115

124116
## Accessing EvOC
125117

package-lock.json

Lines changed: 20 additions & 23 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)