Skip to content

Commit 6f77bf0

Browse files
committedJan 3, 2025
📚 add section to docs/README.md for dockerized docs
1 parent b54fc68 commit 6f77bf0

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed
 

‎docs/README.md

+10
Original file line numberDiff line numberDiff line change
@@ -179,3 +179,13 @@ Tests are written using Jest and can be found in `src/**/*.test.ts` files. The t
179179
- Run tests in sequence (--runInBand)
180180

181181
To create new tests, add a `.test.ts` file adjacent to the code you're testing.
182+
183+
## Docs Updates
184+
185+
Please make sure to vetify if the documentation provided is correct. In order to do so, please run the docs service.
186+
187+
```console
188+
docker compose -f docker-compose-docs.yaml up --build
189+
```
190+
191+
The docusaurus server will get started and you can verify it locally at https://localhost:3000/eliza.

0 commit comments

Comments
 (0)