Documentation Smoke Checklist
Use this checklist whenever the product changes a user-visible workflow, page IA, or capability boundary.
Core Journeys
- Run the current Quick Start end to end against the default Docker bootstrap path.
- Confirm the
Runspage description matches the shipped active runs board, not the pre-redesign table/detail-panel model. - Confirm the documented export path matches the shipped UI and only promises
.eval752.zipif no other format is actually exposed. - Confirm
Comparisoncopy only promises the metrics and panels that are currently rendered.
Truthfulness
- Search docs for unshipped claims such as Arena leaderboard, direct CSV/JSON browser upload, HF Hub push, significance testing, or any feature still described as roadmap-only after it shipped.
- Check roadmap/current-status language: alpha docs must not imply GA or “production-ready” if the release is still alpha.
- If a task moved from roadmap to shipped functionality, update both docs and
specs/3_tasks.mdin the same change.
Runtime & Demo Truthfulness
- Verify Quick Start, provider docs, and run docs no longer describe a seeded demo provider as part of the default user path.
- Verify internal testing docs clearly separate the local OpenAI-compatible test gateway from real provider results.
Cross-Surface Consistency
- Check
Providers,Schedules,Dashboard,Runs, andComparisondocs against the actual navigation labels and primary controls. - If a new page is shipped, add it to the appropriate locale nav file (
docs/en/_nav.jsonordocs/zh/_nav.json) and the nearest section_meta.json, then cross-link it from the nearest user guide index. - If a page becomes localized, search for leftover hard-coded English examples in user-facing docs and test fixtures.
Verification
- Run the focused Playwright journeys for the changed flow when feasible.
- Rebuild or preview docs if navigation changed.
- Update screenshots or recorded steps only after the underlying text has been corrected.
