Quickstart

Get your documentation agent-ready in under 5 minutes.

Prerequisites

Node.js >= 18
pnpm (recommended) or npm

Installation

pnpm add -D @arach/dewey

Initialize

npx dewey init

This creates:

docs/ folder with starter templates
dewey.config.ts configuration file

Configure

Edit dewey.config.ts with your project context:

export default {
  project: {
    name: 'your-project',
    tagline: 'What your project does',
    type: 'npm-package', // or cli-tool, react-library, etc.
  },

  agent: {
    criticalContext: [
      // Rules AI agents MUST know
      'NEVER do X when Y',
    ],
    entryPoints: {
      'main': 'src/',
    },
  },

  install: {
    objective: 'Install and configure your-project.',
    steps: [
      { description: 'Install', command: 'pnpm add your-project' },
    ],
  },
}

Write Documentation

Create docs in the docs/ folder:

docs/
  overview.md      # Project introduction
  quickstart.md    # Getting started guide
  api.md           # API reference
  overview.agent.md  # Agent-optimized version

Generate Agent Files

npx dewey generate

Outputs:

AGENTS.md - Combined context for AI agents
llms.txt - Plain text summary for LLMs
docs.json - Structured documentation
install.md - LLM-executable installation guide

Check Your Score

npx dewey agent

Agent Readiness Report
Overall Score: 75/100 (Grade: C)

Categories:
✓ Project Context: 20/25
○ Agent-Optimized Files: 20/30
...

Create a Doc Site

Turn your markdown into a full static site:

npx dewey create my-docs --source ./docs --theme ocean
cd my-docs
pnpm install && pnpm dev

Features: Astro static HTML, Pagefind search, 8 color themes, dark mode, auto-navigation from frontmatter.

Next Steps

Create .agent.md versions of your docs
Add skills to .claude/skills/ for custom reviews
Run dewey audit to check completeness
Run dewey create to generate a doc site