# Docs List

> Run `scripts/docs-list.ts` to list `docs/` markdown + frontmatter summary/read_when. Use when auditing docs coverage.

- Skill: `marchatton/docs-list` (Agent Skill)
- Install (CLI): `npx skillmds@latest add marchatton/docs-list`
- Raw SKILL.md: https://api.skillmd.com/api/skills/marchatton/docs-list/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Docs & Writing
- Author: marchatton (https://skillmd.com/u/marchatton)
- Updated: 2026-09-22
- Page: https://skillmd.com/skills/marchatton/docs-list

---


# Docs List

## Quick Start

```bash
pnpm dlx tsx scripts/docs-list.ts
```

## Behavior

- Walks `docs/` (skips `archive/`, `research/`).
- Requires frontmatter `summary:`; optional `read_when:` list.
- Output `path - summary` (+ `Read when:`); errors flagged.

## Steps

1. Ensure local copy `scripts/docs-list.ts` (copy from `inspiration/agent-scripts/scripts/docs-list.ts` if missing).
2. Run from repo root.
3. Review errors for missing/stale docs.

## Outputs

- Paths + summaries for `docs/`.
- Missing/stale notes.

## Verification

- Output includes paths + summaries; errors shown.