Skip to content

Comments

Add complete snapshot documentation#495

Merged
MatthewMckee4 merged 1 commit intomainfrom
docs/complete-snapshot-documentation
Feb 22, 2026
Merged

Add complete snapshot documentation#495
MatthewMckee4 merged 1 commit intomainfrom
docs/complete-snapshot-documentation

Conversation

@MatthewMckee4
Copy link
Member

Summary

  • Document command snapshots (karva.Command builder API and karva.assert_cmd_snapshot())
  • Add inline snapshots as a dedicated section covering the inline= parameter, multiline values, and accept workflow
  • Document karva snapshot prune and karva snapshot delete CLI subcommands with --dry-run flag
  • Add snapshots page to site navigation in zensical.toml

Test plan

  • uv run -s scripts/prepare_docs.py && uv run --isolated --only-group docs zensical build passes
  • uvx prek run -a passes
  • Verify snapshots page appears in nav and all sections render correctly

Document previously missing snapshot features:
- Command snapshots (karva.Command builder API and assert_cmd_snapshot)
- Inline snapshots as a dedicated section (inline= parameter, multiline values, accept workflow)
- karva snapshot prune and delete CLI subcommands with --dry-run flag

Also add snapshots page to site navigation in zensical.toml.
@MatthewMckee4 MatthewMckee4 added the documentation Improvements or additions to documentation label Feb 22, 2026
@MatthewMckee4 MatthewMckee4 merged commit b19404e into main Feb 22, 2026
6 checks passed
@MatthewMckee4 MatthewMckee4 deleted the docs/complete-snapshot-documentation branch February 22, 2026 22:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant