Getting Started

Welcome to Dewey — a documentation toolkit that makes your docs AI-agent-ready. Audit, score, and generate optimized documentation for LLM consumption.

Installation

Install the package using your preferred package manager:

bash

npm install -D @arach/dewey

Or with pnpm:

bash

pnpm add -D @arach/dewey

Quick Setup

Initialize your documentation structure:

bash

npx dewey init

This creates a docs/ folder and a dewey.config.ts file:

typescript

import { defineConfig } from '@arach/dewey'

export default defineConfig({
  name: 'my-project',
  docs: './docs',
  output: {
    agentsMd: true,
    llmsTxt: true,
    installMd: true,
  },
})

Note: Run dewey generate after writing your docs to create agent-ready output files.

Core Concepts

Dewey is built around three key ideas:

Agent Content Pattern — Each page has human (.md) and agent (.agent.md) versions
Skills System — LLM prompts that guide AI agents through specific tasks
install.md Standard — LLM-executable install instructions following the installmd.org spec

CLI Commands

Dewey provides these commands:

Command	Description
`dewey init`	Create docs/ folder and config
`dewey audit`	Check documentation completeness
`dewey generate`	Create agent-ready files
`dewey agent`	Score agent-readiness (0-100)

Agent Readiness

Check how well your docs serve AI agents:

bash

npx dewey agent

This scores your documentation from 0-100 and provides actionable recommendations to improve agent compatibility.

What's Next

Read the Configuration guide for advanced setup
Explore the built-in skills for docs review and improvement
Check the components library for building doc sites

Built with care by the Dewey team.