指南
XPerf 文档
XPerf 伞形(多工具包系列)的共享文档。各语言的指南和 Lint 文档存放在各自的包下。
GitHub Pages 会渲染此目录及每个工具包的指南。使用 bash scripts/build-pages.sh serve 进行预览。参见 release.md。
共享文档(本目录)
| 文档 | 目的 |
|---|---|
| branding.md | 显示名称 XPerf 与路径 xperf |
| doc-style.md | 由 scripts/doc-check.sh 执行的 Markdown 规范 |
| release.md | 我们在 v* 标签上发布的内容 |
| overview.md | XPerf 是什么:工具架构、共享循环、证据规则 |
| playbook.md | 操作循环:库存 → 证据 → 语料库 → 反向优化 → 内部测试 → 文档 |
| kits.md | 检查入口点、默认值、语料库准备笔记(仅限短标签) |
| quickstart.md | 每种语言的构建/运行命令 |
| smell-catalog.md | 跨语言气味指数(ID为每套工具的标识符) |
| rule-regression.md | 正/负夹具 + 证据覆盖;诚实的缺口 |
| rule-id-map.md | 历史数字 → 标识符映射(命令行接口不接受数字) |
| roadmap-next.md | 以相同方法进行下一项工作 |
| static-check-sources.md | 论坛、博客和 GitHub 上 linter 可以检测到的形状的来源 |