website

README

agentgateway-dev/website Contribution Guide

Getting Started

Required dependencies:

• node.js v18.18.2 or later
• hugo extended v0.160.1 or later

To run a local preview:

1. gh repo clone agentgateway/website

2. cd website

3. npm install

4. hugo server

5. http://localhost:1313

Framework tests

Rendered-HTML quality is checked by a shared Playwright harness that lives in solo-io/docs-theme-extras. The harness asserts structural things (no shortcode delimiter leaks, no raw markdown bleed, image alt text, tabs/mermaid/copy-md rendered correctly, internal links resolve, etc.) against the built public/ tree.

These are distinct from the doc tests (make test-run), which execute code blocks against a cluster. Framework targets are prefixed framework-test-*.

One-time setup

Clone docs-theme-extras as a sibling of this repo:

cd ../
git clone https://github.com/solo-io/docs-theme-extras.git
cd <agentgateway/website_clone_directory>
make framework-test-install   # ~1-3 min, ~120-180 MB

If your clone lives somewhere else

The Makefile defaults to FRAMEWORK_EXTRAS_DIR=../docs-theme-extras. Override it when your clone is at a different path. Three ways, pick whichever fits your workflow:

# 1. Per-command (no shell state):
make framework-test-static FRAMEWORK_EXTRAS_DIR=/abs/path/to/docs-theme-extras

# 2. Exported for the shell session (all subsequent `make` calls pick it up):
export FRAMEWORK_EXTRAS_DIR=/abs/path/to/docs-theme-extras
make framework-test-static

# 3. Persistent: add the export to your ~/.zshrc (or ~/.bashrc).

The same variable works for framework-test-install and every other framework-test-* target.

Day-to-day

make framework-test-static          # fastest, no browser launch
make framework-test-browser         # chromium only (tabs, mermaid, copy-md, ...)
make framework-test-cross-browser   # chromium + firefox + webkit
make framework-test                 # full suite
make framework-test-report          # re-open the last HTML report

Each target builds the site first with hugo160 --gc --minify (the local build pin), then runs the harness via DOCS_TEST_CONFIG=./.docs-test.toml. The HTML report auto-opens after the run; Ctrl+C dismisses the report server. CI pins to Hugo 0.160.1 via peaceiris/actions-hugo@v3.

CI

The same harness runs on PRs via .github/workflows/framework-tests.yml, which pins to the SHA of docs-theme-extras recorded in go.mod so layouts and tests stay in lockstep.

Contributors

We’d love to highlight the contributors and organizations behind agentgateway! 🌟 See CONTRIBUTING.md for how to contribute to the project and how to add your organization’s logo to the homepage. Thank you for your support! 💖

Documentation

Overview

Package website exists so Go module tooling can enumerate this Hugo site module.