Summary
Make the most important README/docs examples executable in CI so user-facing examples cannot silently drift away from the real API.
Why
FrameVitals exposes many workflows—analysis, drift, contracts, gates, snapshots, source inspection, CLI, and optional backends. Keeping examples runnable is one of the cheapest ways to protect the user experience as APIs evolve.
Scope
- Select a small canonical set of examples from README/docs.
- Convert them into executable scripts or doctest-style snippets.
- Use deterministic small fixtures so CI stays fast.
- Cover at least one optional-source path when dependencies are installed.
- Keep example outputs concise and stable.
Acceptance criteria
Priority: P2 — documentation / contributor-friendly
Suggested labels: documentation, testing, good-first-issue
Summary
Make the most important README/docs examples executable in CI so user-facing examples cannot silently drift away from the real API.
Why
FrameVitals exposes many workflows—analysis, drift, contracts, gates, snapshots, source inspection, CLI, and optional backends. Keeping examples runnable is one of the cheapest ways to protect the user experience as APIs evolve.
Scope
Acceptance criteria
Priority: P2 — documentation / contributor-friendly
Suggested labels: documentation, testing, good-first-issue