Skip to content

fix: Document missing snapshot acceleration parameters#1517

Merged
lukekim merged 2 commits intotrunkfrom
fix/docs-missing-snapshot-params
Apr 16, 2026
Merged

fix: Document missing snapshot acceleration parameters#1517
lukekim merged 2 commits intotrunkfrom
fix/docs-missing-snapshot-params

Conversation

@claudespice
Copy link
Copy Markdown
Collaborator

Summary

  • Two acceleration snapshot parameters introduced in v1.11.0 were missing from the reference documentation:
    • acceleration.snapshots_creation_policy — controls whether snapshots are created after every refresh (always) or only when data changes (on_change, default)
    • acceleration.snapshots_reset_expiry_on_load — controls whether snapshot expiry is reset when loading during bootstrap (disabled default, enabled)

Changes

  • Added documentation for both parameters to the datasets reference in vNext and v1.11.x

Reference

Verified against spiceai/spiceai at trunk and v1.11.5 — crates/spicepod/src/acceleration/mod.rs defines both enums with their defaults.

Add documentation for two undocumented acceleration snapshot parameters
that were introduced in v1.11.0:

- `acceleration.snapshots_creation_policy` (default: `on_change`) —
  controls whether snapshots are created after every refresh or only
  when data changes
- `acceleration.snapshots_reset_expiry_on_load` (default: `disabled`) —
  controls whether snapshot expiry is reset when loading during bootstrap

Added to vNext and v1.11.x reference docs.

Verified against spiceai/spiceai at trunk and v1.11.5 —
crates/spicepod/src/acceleration/mod.rs defines both parameters.
@claudespice claudespice added the bug Something isn't working label Apr 16, 2026
@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 16, 2026

🔍 Pull with Spice Failed

Passing checks:

  • ✅ Title meets minimum length requirement (10 characters)
  • ✅ No banned labels detected
  • ✅ Has at least one assignee: lukekim

Failed checks:

  • ❌ Please select at least one of the required labels for this pull request: area/blog, area/docs, area/cookbook, dependencies

Please address these issues and update your pull request.

@github-actions
Copy link
Copy Markdown

🚀 deployed to https://2935855d.spiceai-org-website.pages.dev

@lukekim lukekim self-assigned this Apr 16, 2026
@github-actions
Copy link
Copy Markdown

🚀 deployed to https://e93418d6.spiceai-org-website.pages.dev

@lukekim lukekim merged commit e7ec19f into trunk Apr 16, 2026
6 of 7 checks passed
@lukekim lukekim deleted the fix/docs-missing-snapshot-params branch April 16, 2026 16:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/docs bug Something isn't working

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants