AI and agents
Machine-readable docs
Documentation endpoints intended for AI systems, code generators, and agent discovery.
Whagons publishes public documentation in formats that agents can discover and consume without scraping the rendered interface.
Discovery map
| Resource | URL | Purpose |
|---|---|---|
| Agent guide | /agents.md | Compact entry point for agents using Whagons. |
| Documentation index | /llms.txt | Public page list with descriptions. |
| Full public docs | /llms-full.txt | Combined public documentation corpus. |
| Page Markdown | /docs/<path>.md | Markdown negotiation alias for an individual page. |
| Page content route | /llms.mdx/docs/<path>/content.md | Direct processed Markdown for a page. |
| OpenAPI | /openapi/whagons-v1.json | REST contract for v1. |
| Agent authentication | https://gon.whagons.com/auth.md | Live authentication discovery and implemented scopes. |
| OAuth resource metadata | https://gon.whagons.com/.well-known/oauth-protected-resource | Structured protected-resource metadata. |
Suggested agent sequence
- Read
/agents.mdfor the service map and safety rules. - Read
/openapi/whagons-v1.jsonfor endpoint shapes. - Choose a credential path: a user-supplied Settings key or delegated
auth.mdclaim. - Resolve the tenant's reference IDs before writing tasks.
- Apply the same least-privilege and secret-handling rules described in the human docs.
Public and private content
llms.txt, llms-full.txt, search, navigation, and the public sitemap exclude internal maintainer documentation. Requests for internal page, Markdown, and social-image routes require separate authentication.
Agents should not attempt to bypass that boundary or treat a public link to an internal slug as authorization.