Codex Resources

Auto-generate documentation from your Codex resources.

Overview

zudo-doc can automatically generate documentation pages from your project's Codex resources — AGENTS.md files, configuration profiles, custom agents, hooks, rules, and skills. When enabled, these pages appear under the Codex header navigation section.

Enabling Codex Resources

Set codexResources in zfb.config.ts:

export default defineConfig(
  zudoDoc({
    codexResources: {
      codexDir: ".codex",
    },
  }),
);

Set it to false to disable the integration:

codexResources: false,

What Gets Generated

The integration creates the following documentation sections:

Each resource section has an index page, and discovered resources are rendered as individual detail pages.

How It Works

The integration runs at build time as the @takazudo/zudo-doc/plugins/codex-resources zfb plugin. When codexResources is configured, zudoDoc() wires in the plugin automatically. Its preBuild hook:

1. Resolves projectRoot, scanRoot, and the configured .codex/ directory

2. Walks scanRoot for AGENTS.md and AGENTS.override.md files

3. Discovers configuration, agents, hooks, rules, and skills from the configured resource locations

4. Generates MDX index and detail pages in the seven codex* directories

5. Makes those pages available to zfb's content collections for rendering

The generated pages appear under the Codex header navigation tab. Configure the tab with categoryMatch: "codex" so it activates for every generated Codex section.

Set the header item to versioned: false. Generated Codex routes exist only in the default docsDir; they are never written beneath /v/{version}, so a version-aware link would point to a route that does not exist while an archived version is active.

Configuration Options