Skip to content

Edit documentation

OpenGateLLM uses Astro Starlight to serve its documentation. Start the local development server with the following command:

  1. Go to the documentation folder

    Terminal window
    cd docs
  2. Install the dependencies

    Terminal window
    npm install
  3. Run the development server

    Terminal window
    npm run dev

    This will:

    • Install the dependencies
    • Launch a development server at http://localhost:4321/
    • Hot-reload changes as you edit files
  4. Edit the documentation

    • astro.config.mjs Astro configuration file
    • Directorysrc
      • Directoryassets Assets folder
        • Directoryicons/ Custom icons SVG folder
      • Directorycontent
        • Directorydocs/ Documentation markdown files folder
  1. Install asciinema ((see documentation)[https://docs.asciinema.org/getting-started/])

  2. Create a recording of the terminal command

    Terminal window
    # example for make quickstart command
    asciinema rec docs/src/assets/make_quickstart.cast \
    --overwrite \
    --command "make quickstart" \
    --title "make quickstart" \
    --window-size 120x24
  3. Build asciinema gif generator (agg) image docker to convert the recording to a GIF (see asciinema/agg)

  4. 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