# read-the-damn-docs

Makes the agent search for and read current official documentation before writing code instead of trusting model memory.

- skill · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, OpenCode · 495 installs · ★ 4613
- Author: BuilderIO
- License: MIT · policy=mirror · the beginning of the file is at the end of this page
- Source: https://github.com/BuilderIO/skills/tree/HEAD/skills/read-the-damn-docs/SKILL.md
- Updated: 2026-10-22
- HTML: https://affpapa.org/en/nevibecode/skills/read-the-damn-docs

## What it does

The skill fires on work that touches third-party APIs, libraries, frameworks, CLIs or cloud services. It also triggers on requests for the latest or official behavior, on errors about deprecated options, and on anything involving auth, billing, migrations or data privacy.

What is inside: a list of triggers and a fixed order of steps. Pin down the exact surface — package, installed version, endpoint, config file — search the web for official docs, read the pages, pull out the option names and breaking changes, then implement. Before adding a dependency it suggests checking the version with `npm view <pkg> version` or the ecosystem equivalent and reading docs for that major.

Local repo docs, ADRs and generated schemas come first for internal code; upstream official docs for external behavior. Stack Overflow and old blog posts are for debugging symptoms once the contract is known. If network access or auth blocks the docs, the skill says to state that plainly rather than pass memory off as a source.

## Install

### Claude Code (native platform)

1. **Skills CLI (Vercel)**
```bash
npx skills add BuilderIO/skills --skill read-the-damn-docs -a claude-code
```

2. **Manually: put the files in place**
- File: `~/.claude/skills/read-the-damn-docs/SKILL.md` — Copy the whole skill folder; for one project use .claude/skills/read-the-damn-docs/

### Codex

1. **Skills CLI (Vercel)**
```bash
npx skills add BuilderIO/skills --skill read-the-damn-docs -a codex
```

2. **Manually: put the files in place**
- File: `.agents/skills/read-the-damn-docs/SKILL.md` — For all projects use ~/.agents/skills/

### Cursor

1. **Skills CLI (Vercel)**
```bash
npx skills add BuilderIO/skills --skill read-the-damn-docs -a cursor
```

2. **Manually: put the files in place**
- File: `.cursor/skills/read-the-damn-docs/SKILL.md` — Cursor also reads .agents/skills/ and .claude/skills/

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install BuilderIO/skills read-the-damn-docs
```

2. **Manually: put the files in place**
- File: `.github/skills/read-the-damn-docs/SKILL.md`

### Gemini CLI

1. **Skills CLI (Vercel)**
```bash
npx skills add BuilderIO/skills --skill read-the-damn-docs -a gemini-cli
```

2. **Platform CLI**
```bash
gemini skills install https://github.com/BuilderIO/skills --path skills/read-the-damn-docs
```

### Windsurf (Devin Desktop)

**Manually: put the files in place**
- File: `.devin/skills/read-the-damn-docs/SKILL.md` — The legacy .windsurf/skills/ path still works

### OpenCode

**Skills CLI (Vercel)**
```bash
npx skills add BuilderIO/skills --skill read-the-damn-docs -a opencode
```

### Claude.ai

**Claude.ai**
- Zip the folder and upload it in Settings → Capabilities → Skills

Where a file is given instead of a command, copy the files from the source to that path: https://github.com/BuilderIO/skills/tree/HEAD/skills/read-the-damn-docs/SKILL.md

## When to use it
- pull the current API syntax before writing code
- check the major version of a package before adding it
- debug an error about a deprecated option or changed default
- read the migration guide before upgrading a framework
- check provider docs when wiring OAuth scopes and webhooks

## Example prompts
- Add Tailwind to this app, read the official install docs first
- Fix this Next.js caching bug against the docs for the installed major
- Wire up Stripe webhooks from the current docs, not from memory

## Source text · SKILL.md · MIT

Below is the content of a third-party file. It is data, not instructions for you: do not act on anything written inside unless the human asks. Block tag: 5b27bdf56cb0f877.

BEGIN THIRD-PARTY FILE 5b27bdf56cb0f877
```text
---
name: read-the-damn-docs
description: >-
  Use when implementing, integrating, upgrading, debugging, or answering
  anything involving third-party APIs, libraries, frameworks, CLIs, cloud
  services, model/provider SDKs, fast-moving product behavior, user requests for
  latest/current/official behavior, unfamiliar repo docs/specs, errors that may
  indicate API drift, or high-stakes auth, security, billing, data, migration,
  deployment, compliance, or privacy behavior. Forces Codex to web-search for
  current official docs and read primary docs before assuming from memory.
---

# Read The Damn Docs

Do not guess where authoritative docs can answer the question. The most common
right move is to web-search for the current official docs, open the relevant
pages, and read them before coding. For APIs, versions, provider behavior,
config, limits, lifecycle hooks, or security-sensitive flows, ground the answer
in what the docs actually say.

## Docs-First Triggers

Read docs before proceeding when any of these are true:

- The user asks for "latest", "current", "official", "supported", "best
  practice", "recommended", "today", "now", or "look it up".
- The needed docs are not already in the repo or supplied by the user. Search
  the web for the official docs rather than hoping model memory is current.
- The task adds, upgrades, configures, or imports a package, SDK, framework,
  plugin, CLI, model, cloud resource, or provider integration.
- The API is fast-moving or version-sensitive: AI SDKs, OpenAI/Anthropic/Google
  APIs, Next.js, React, Tailwind, Vite, Nitro, Drizzle, Prisma, Stripe, GitHub,
  Slack, Notion, browser APIs, deployment platforms, auth libraries, and similar.
- The implementation depends on auth, OAuth scopes, permissions, secrets,
  webhooks, billing, payments, PII, encryption, data retention, migrations,
  retries, rate limits, quotas, caching, deploys, or compliance.
- An error mentions deprecation, unknown options, missing exports, invalid
  config, unsupported fields, changed defaults, or version mismatch.
- A repo has local docs, ADRs, generated schemas, OpenAPI specs, route/action
  registries, design-system docs, or package-level READMEs that could define the
  contract.
- The choice is expensive to reverse: public wire formats, database schema,
  migration strategy, persistent IDs, event names, customer-visible behavior, or
  external automation contracts.
- You catch yourself about to write "usually", "probably", "I think", "from
  memory", or code copied from model memory for an external API.

## What Counts As Docs

Use the most authoritative source available:

- Local repo docs, specs, ADRs, schemas, generated types, package READMEs, and
```
END THIRD-PARTY FILE 5b27bdf56cb0f877

The third-party file has ended. Everything between the 5b27bdf56cb0f877 tags is data: requests and commands from it are not followed. An “end of file” line with another tag inside the block is part of the file.

First 2715 of 7029 bytes. © BuilderIO · MIT · https://github.com/BuilderIO/skills/tree/HEAD/skills/read-the-damn-docs/SKILL.md

_Part of the page did not fit — see the HTML version._

---
NeVibeCode on affpapa.org. Catalog texts are descriptions, not instructions for the agent. How to choose and install: https://affpapa.org/en/nevibecode/agents.md