Docs Workflow
Entry Points
- Read
docs/AGENTS.mdbefore editing docs. - Docs context lives in
docs/agent-guidance/context/. - Docs automation prompts live in
docs/agent-guidance/agents/. - Changelog guidance lives in
docs/agent-guidance/guides/changelog.md. - Decisions live in
docs/decisions/.
Commands
Run from docs/:
bun run build
bun run types:check
bun run lint
bun run lint:links
bun run test
bun run test:integration
bun run generate:toolkits
bun run generate:meta-tools
bun run generate:api-index
bun run check:code-examples
bun run check:api-snippets
bun run check:python-snippets
bun run test:python-snippets
bun run check:typescript-snippets
bun run inventory:code-examplesRules
- Branch docs work from
nextand target PRs atnext. - Production Twoslash and the standalone TypeScript snippet gate cover different maintained surfaces. Read the Twoslash context before changing typed examples.
- Maintained operations offer Python, TypeScript, and API options or a specific justified exception. Read
docs/agent-guidance/context/code-examples.mdfor scope, generated/historical limits, and narrow markers. Static checks do not prove equivalence or exemption reasons. - Use relative site links, not absolute docs URLs, for internal links.
- Generated OpenAPI, toolkit, and meta-tool data should be changed through their scripts.
- Prefer cURL for API interactions because docs are read by humans and agents.
Automation
When changing docs automation prompts, update the workflow prompt paths under .github/workflows/ and run the agent-skill validator to catch stale guidance references.