Registry | Nimbus

The registry is what nimbus-docs add reads from. Four types of entries: components and utilities copy as files; features and content sources hand off a guide to a coding agent.

Four types

registry:ui — UI components. Copied into src/components/ui/<slug>/. Examples: Badge, Card, Steps.
registry:lib — Standalone utilities. Copied to specific paths. Example: cn → src/lib/cn.ts.
registry:feature — Agent-handoff recipes. Nothing copies; the CLI prints markdown the agent reads, adapts to your project, and applies. Example: 404-page.
registry:source — Content sources, added with nimbus-docs add source <name>. A guide for the agent, which writes any code the source needs into your site. Examples: github, notion.

Anatomy of an entry

badge: {
  type: "registry:ui",
  title: "Badge",
  description: "Small status / category pill.",
  registryDependencies: ["cn"],
},

type — registry:ui, registry:lib, registry:feature, or registry:source.
registryDependencies — other slugs the CLI must install first. Walked transitively.
dependencies — npm packages added to package.json.

Install graph

When you run npx @cloudflare/nimbus-docs add accordion, the CLI walks the slug’s dependency graph:

accordion
├── collapsible
└── cn

It installs collapsible and cn before accordion. Each lands at the path declared in the manifest. Duplicates are skipped.

Features don’t have an install graph — the recipe is self-contained markdown the agent applies inside your existing layout.

Features

A feature is an agent-handoff recipe — nothing copies as files. Install any with npx @cloudflare/nimbus-docs add <slug>; the CLI prints a brief your coding agent adapts to your project and applies.

pagefind-search — static full-text search and the Nimbus search dialog.
ai-native — llms.txt indexes, alternate Markdown/MDX versions, robots.txt, and an AgentDirective.
mermaid — lazy, theme-aware Mermaid diagrams with a full-screen expand.
404-page — a brand-matched 404 page for your docs.
lint-prose-textlint — textlint with write-good, alex, and terminology rules.
changelog — a dated /changelog feed with tags, RSS, and permalinks.
component-showcase — a /components grid and per-component pages for your UI.
new-collection — a non-version content tree: blog, API, or glossary.
api-reference — mount an OpenAPI spec as generated reference pages with alternate Markdown versions, styled with the owned api-layout / api-sidebar / api-field-row / api-code-rail components.
new-version — wire a new docs version end-to-end, with a switcher.

Sources

A source builds part of the site from somewhere other than src/content. Add one with npx @cloudflare/nimbus-docs add source <name|url>:

git (also github, gitlab, bitbucket) — pages from another git repository, checked out at build time.
notion — pages from a Notion database; the agent writes src/loaders/notion.ts from the guide.
a URL — a guide for writing a loader for any other provider, from its docs.

See Content from other sources.

Content recipes

Templates for writing one page of a given shape — the agent scaffolds the structure for you to fill in. Same command: npx @cloudflare/nimbus-docs add <slug>.

content-overview — orient in one paragraph, then route onward.
content-quickstart — the shortest honest path to one working result.
content-tutorial — numbered parts that build one real project.
content-how-to — numbered steps from a goal to a verified outcome.
content-concept — what a thing is, why, and where its edges are.
content-reference — a complete, neutral, templated lookup page.
content-example — runnable code to copy whole, prose where needed.
content-troubleshooting — symptoms, causes, and fixes, titled by search terms.
content-changelog — dated, categorized records that flag breakage.