writing-emdash-docs

Read the EmDash docs style guide and the implementation behind every claim before drafting. Classify the page by reader need (tutorial, task guide, reference, etc.), draft with the reader's outcome first, then run the anti-slop pass and verify with pnpm lint:quick and a docs build.

Use the anti-slop reference to inspect each sentence: delete staged reveals, significance labels, generic AI vocabulary, and chatbot residue, replacing them with verified facts. Preserve legitimate caveats, contrasts that correct misconceptions, and precise technical terms to avoid overcorrection.

A migration guide identifies who is affected, states previous and current behavior only as needed, gives the required action with a minimal before-and-after diff, and ends with a verifiable working state. Include ordering, rollback, and compatibility constraints when applicable.

It is designed for the EmDash repository and depends on its style guide, AGENTS.md, and pnpm-based checks. The general principles in the docs-practice and anti-slop references transfer to other projects, but repository-specific steps assume the EmDash codebase.

Run the narrowest checks covering the change: pnpm lint:quick, pnpm --dir docs build, and git diff --check. Add tests when code samples depend on executable behavior, and record any pre-existing repository-wide failures separately.