Guides
XPerf docs
Shared documentation for the XPerf umbrella (multi-kit family). Per-language guides and lint docs live under each package.
GitHub Pages renders this directory and the per-kit guides. Preview with bash scripts/build-pages.sh serve. See release.md.
Shared (this directory)
| Doc | Purpose |
|---|---|
| branding.md | Display name XPerf vs paths xperf |
| doc-style.md | Markdown conventions enforced by scripts/doc-check.sh |
| release.md | What we publish on v* tags |
| overview.md | What XPerf is: kit architecture, shared loop, evidence rule |
| playbook.md | Operating loop: inventory → evidence → corpus → reverse-opt → dogfood → docs |
| kits.md | Lint entry points, defaults, corpus-ready notes (slug-only) |
| quickstart.md | Per-language build/run commands |
| smell-catalog.md | Cross-language smell index (IDs are per-kit slugs) |
| rule-regression.md | Positive/negative fixtures + evidence coverage; honest gaps |
| rule-id-map.md | Historical numeric → slug map (CLI does not accept numerics) |
| roadmap-next.md | Next work under the same method |
| static-check-sources.md | Forum, blog, and GitHub sources for shapes a linter can see |