For AI agents: a Markdown copy of this page is at https://paulbouwer.github.io/hello-kubernetes/docs/agents.md. The index of every page, for the latest release, is at https://paulbouwer.github.io/hello-kubernetes/llms.txt.
For AI agents
The docs are written for people, and published for agents too. An agent can read them as plain Markdown, without the site’s layout, tabs or scripts.
What’s published
Section titled “What’s published”| File | What it has |
|---|---|
/llms.txt |
An index in the llms.txt format: one line for each page, with its description and a link to its Markdown copy. |
A .md copy of each page |
The page as Markdown, next to it: /docs/deploy/helm/ has /docs/deploy/helm.md. Each code group lists every tab, such as kubectl and Helm, with its own code block. |
/llms-full.txt |
Every page in one file, in sidebar order. |
/values.schema.json |
The JSON Schema that Helm checks the chart’s values against. It has a description of every value. |
Every page also has a Copy page as Markdown button under its title, to paste a page into a chat.
Using them from an agent
Section titled “Using them from an agent”- Start from
llms.txt. Open only the pages the task needs, and come back to the index for others. It is much smaller thanllms-full.txt. - Check values against the schema before running
helm install. Helm rejects unknown keys and wrong types, so a value that isn’t in the schema fails the install. - Mind the version. The site has the docs for the latest release only.
llms.txtnames it. For an older release, read the docs in the repo at that release’s tag.
For example, ask your agent:
Read https://paulbouwer.github.io/hello-kubernetes/llms.txt, then deployhello-kubernetes behind my Traefik Ingress at /app/hello.Agents that work on the repo
Section titled “Agents that work on the repo”These docs are for using hello-kubernetes. An agent that changes the app, the chart or the site should read AGENTS.md in the repo first. It has the scope, the rules, and how each change is planned, built and checked.