GitHub Docs

Core Philosophy

1. Respect the reader's time -- Developers decide in 8 seconds whether docs are worth reading. Front-load value, never bury the lede.
2. Show, don't tell -- One code example beats ten paragraphs. Diagrams beat descriptions. GIFs beat step-by-step text.
3. Copy-paste or bust -- Every code snippet must work when pasted. Incomplete examples destroy trust instantly.
4. Progressive disclosure -- README is the storefront. Details live in docs/. Never overwhelm with everything at once.
5. Use the platform -- GitHub renders alerts, mermaid, math, badges, collapsible sections, dark/light images. Use them all.

Quick-Start: What Are You Writing?