Skip to content

docs: add OSS agentgateway assistant skills and setup guides - #1523

Open
jamesilse-solo wants to merge 12 commits into
agentgateway:mainfrom
jamesilse-solo:docs/oss-assistant-skills
Open

jamesilse-solo wants to merge 12 commits into
agentgateway:mainfrom
jamesilse-solo:docs/oss-assistant-skills

Conversation

@jamesilse-solo

Copy link
Copy Markdown
Contributor

Customers using an AI assistant need instructions that select the correct agentgateway edition and deployment mode, retrieve applicable documentation, and distinguish generated configuration from verified behavior. This adds installable OSS skills for standalone and Kubernetes controller deployments, with a dedicated setup guide linked from the quickstart and installation pages.

Changes

  • Add the two complete OSS skill packages, public documentation and workshop references, and optional verification helpers for runtime evidence, MCP results, and controlled masking checks.
  • Add “Set up with an AI assistant” pages for standalone and Kubernetes in latest and main. Include Claude/Codex installation and activation, OpenAI/Vertex AI/Bedrock examples, and update/removal guidance.
  • Distribute through npx skills and complete ZIP downloads at stable current URLs. Generated hashes identify the contents; skills have no dated release counter or gateway version allowlist.
  • Keep OSS implementation explicit and disclose relevant, verified Enterprise capabilities without recommending an upgrade. Guard quickstart callouts so importing downstream documentation does not inherit OSS installation guidance.
  • Add deterministic packaging, integrity/helper tests, isolated installer lifecycle checks, and an optional authenticated client acceptance job. PR CI uses no model credentials; the optional client job requires a configured trusted runner.

Validation

  • Package metadata and generated downloads match their sources.
  • 21 verification-helper and integrity tests passed.
  • Installer lifecycle checks passed for discovery, complete-folder installation, selected updates, backups, and removal.
  • Both OSS skills previously passed actual Claude and Codex activation/reference-loading and constrained-behavior checks; the instruction/helper content fingerprints are unchanged.
  • Hugo build passed after rebasing onto current main (one existing .Site.Data deprecation warning).
  • Browser checks passed for all four guides: synchronized client tabs, downloadable ZIPs, mobile layout, and no page errors. All 14 quickstart/install discovery callouts render once in visible content.

The client checks use a read-only fixture with MCP/hooks disabled. They do not certify live provider authentication, cluster deployment, licensing, budget enforcement, or UI reachability. The guides and skills are marked as previews. Scheduled documentation monitoring and automated instruction changes are not enabled by this PR.

Signed-off-by: James Ilse <james.ilse@solo.io>
jamesilse-solo and others added 5 commits November 12, 2026 18:35
Signed-off-by: James Ilse <james.ilse@solo.io>
Retitle to "Skill for AI assistants", move it first under Get started,
and reword the intro and callouts so it is clear the page installs a
skill that sets up agentgateway, rather than exposing an AI assistant
through agentgateway. The page URL is unchanged.

Signed-off-by: Art Berger <art.berger@solo.io>
Generate /.well-known/agent-skills/index.json (Agent Skills discovery
v0.2.0) with root-layout archives so that `npx skills add
https://agentgateway.dev` finds both OSS skills. Point agents at it from
the docs landing page (HTML and markdown twin) and /docs/llms.txt.

Signed-off-by: Art Berger <art.berger@solo.io>
Signed-off-by: Art Berger <art.berger@solo.io>
Signed-off-by: James Ilse <james.ilse@solo.io>
@jamesilse-solo
jamesilse-solo force-pushed the docs/oss-assistant-skills branch from fee66b0 to c7983e6 Compare November 13, 2026 02:35
Comment thread layouts/llms.txt
@@ -0,0 +1,44 @@
{{- /* Override the shared theme's root llms.txt template to expose the skill index; keep the rest aligned with upstream. */ -}}

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is overriding the shared theme from an already-outdated llms.txt...I am going to update the theme to support local overrides for the skill so that we don't have drift.

solo-io/docs-theme-extras#95

Comment thread content/docs/_index.md Resolved
Co-authored-by: Art <artberger@users.noreply.github.com>
Signed-off-by: jamesilse-solo <112434283+jamesilse-solo@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants