AGENTS.md#

kubb-docs is the component-free content repository for the Kubb documentation site. It holds hand-written markdown pages for plugins, adapters, parsers, guides, blog posts, and snippets — consumed by the platform fetch pipeline and rendered on kubb.dev.

High-level architecture#

This is a content-only repository:

No npm packages, no TypeScript, no tests
All files are markdown (.md) or code snippet files
The platform repo (kubb-labs/platform) pulls content from this repo via apps/kubb.dev/scripts/fetchRepos.ts and renders it with VitePress

Repository layout#

docs/
├── docs/5.x/** # Hand-written guide and reference pages
├── plugins/<id>/ # One folder per plugin: index.md plus optional guide/recipes/reference subpages
├── adapters/<id>/ # One folder per adapter: index.md plus optional subpages
├── parsers/<id>/ # One folder per parser: index.md plus optional subpages
├── blog/*.md # Blog posts
├── snippets/** # Code snippets included via <!--@include: ../snippets/...-->
├── CONTRIBUTING.md # Contributing guide
└── README.md # Overview and authoring reference

Content rules#

Plugin, adapter, and parser pages mirror those in the platform repo at apps/kubb.dev/. When a plugin's options change in kubb-labs/kubb or kubb-labs/plugins, update the matching page here in the same PR.

Do NOT edit:

docs/5.x/changelog.md — auto-generated from the core repo by the platform pipeline

Token optimized CLI (rtk)#

rtk is a CLI proxy that filters and compresses command output to cut token usage. Prefix shell commands with it so output stays small:

rtk git status
rtk git log -10

How agents read this repo#

AGENTS.md is the canonical instruction file. CLAUDE.md, GEMINI.md, and
.github/copilot-instructions.md symlink to it. Skills live in .agents/skills/ (open
SKILL.md format, cross-provider, symlinked at .claude/skills/). Always-on conventions live
in .claude/rules/ (markdown, plain-language, security, usa-english).

Skills#

You have new skills. If any skill might be relevant then you MUST read it.

documentation - Use when writing blog posts or documentation markdown files - provides writing style guide (active voice, present tense), content structure patterns, and SEO optimization.
humanizer - Remove AI writing patterns to make documentation sound natural, specific, and human. Covers content patterns, language patterns, style patterns, and communication patterns.
pr - Open or update a pull request in this content repo. Covers what to check on a markdown change, frontmatter and include rules, Conventional Commit titles, how to fill the PR template, and what to do once CI runs. Use when asked to open a PR, push a branch for review, fix a red PR, or judge whether a branch is ready to merge.

Repository layout#

docs/
├── docs/5.x/** # Hand-written guide and reference pages
├── plugins/<id>/ # One folder per plugin: index.md plus optional guide/recipes/reference subpages
├── adapters/<id>/ # One folder per adapter: index.md plus optional subpages
├── parsers/<id>/ # One folder per parser: index.md plus optional subpages
├── blog/*.md # Blog posts
├── snippets/** # Code snippets included via <!--@include: ../snippets/...-->
├── CONTRIBUTING.md # Contributing guide
└── README.md # Overview and authoring reference

Content rules#

Do NOT edit:

docs/5.x/changelog.md — auto-generated from the core repo by the platform pipeline

How agents read this repo#

Skills#

You have new skills. If any skill might be relevant then you MUST read it.

documentation - Use when writing blog posts or documentation markdown files - provides writing style guide (active voice, present tense), content structure patterns, and SEO optimization.

humanizer - Remove AI writing patterns to make documentation sound natural, specific, and human. Covers content patterns, language patterns, style patterns, and communication patterns.

pr - Open or update a pull request in this content repo. Covers what to check on a markdown change, frontmatter and include rules, Conventional Commit titles, how to fill the PR template, and what to do once CI runs. Use when asked to open a PR, push a branch for review, fix a red PR, or judge whether a branch is ready to merge.