Edit documentation
OpenGateLLM uses Astro Starlight to serve its documentation. Start the local development server with the following command:
-
Go to the documentation folder
Terminal window cd docs -
Install the dependencies
Terminal window npm install -
Run the development server
Terminal window npm run devThis will:
- Install the dependencies
- Launch a development server at http://localhost:4321/
- Hot-reload changes as you edit files
-
Edit the documentation
- astro.config.mjs Astro configuration file
Directorysrc
Directoryassets Assets folder
Directoryicons/ Custom icons SVG folder
- …
Directorycontent
Directorydocs/ Documentation markdown files folder
- …
Create terminal GIF
Section titled “Create terminal GIF”-
Install asciinema ((see documentation)[https://docs.asciinema.org/getting-started/])
-
Create a recording of the terminal command
Terminal window # example for make quickstart commandasciinema rec docs/src/assets/make_quickstart.cast \--overwrite \--command "make quickstart" \--title "make quickstart" \--window-size 120x24 -
Build asciinema gif generator (agg) image docker to convert the recording to a GIF (see asciinema/agg)
-
Convert the recording to a GIF
Terminal window docker run --rm -it -u $(id -u):$(id -g) \-v $PWD:/data agg \/data/docs/src/assets/make_quickstart.cast \/data/docs/src/assets/make_quickstart.gif