Rewrite Checkpoints concept doc #107
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Remove redundant Sprites explanation (readers come from other pages) - Tighten language, add specific timing (~300ms) - More direct closing sentence Co-Authored-By: Claude Opus 4.5 <[email protected]>
- Fix typos (extra space, "setup sand") - Simplify bullet list formatting - Remove redundant 300ms mention (in intro) - Consolidate "don't include" items into prose - Explain copy-on-write in plain terms Co-Authored-By: Claude Opus 4.5 <[email protected]>
- Remove redundant speed/interrupt mentions (covered earlier) - Remove code comment that duplicated prose - Tighten SDK intro paragraph Co-Authored-By: Claude Opus 4.5 <[email protected]>
Align with API reference: - Go: use CreateCheckpointWithComment, handle ProcessAll error - JavaScript: use async iterable instead of manual stream reading - Elixir: simplify message handling Co-Authored-By: Claude Opus 4.5 <[email protected]>
- Fix CLI command: sprite restore -> sprite checkpoint restore - Fix typo: Considerationss -> Considerations - Update SDK examples to match API reference - Tighten prose, remove redundant info - Simplify considerations list Co-Authored-By: Claude Opus 4.5 <[email protected]>
- Fix typos in intro, remove filler sentence - Simplify CLI output table formatting - Remove ctx declarations from Go examples - Rename 'Checkpoint Information' to 'Get Checkpoint Details' - Rename 'Deleting Checkpoints' to 'Delete a Checkpoint' - Simplify delete callout, merge Cleanup Considerations Co-Authored-By: Claude Opus 4.5 <[email protected]>
- Rename from 'Manage Checkpoints with the API Inside Your Sprite' - Remove filler phrases and redundant explanations - Fix incorrect llm.txt reference (it's read-only docs, not writable) - Consolidate NDJSON format info - Fix response format to use 'type' field (matches API reference) - Simplify self-checkpointing example Co-Authored-By: Claude Opus 4.5 <[email protected]>
- Remove redundant copy-on-write bullet (explained earlier) - Simplify marketing-style language - Fix em-dash Co-Authored-By: Claude Opus 4.5 <[email protected]>
- Fix sprite restore -> sprite checkpoint restore (3 occurrences) - Remove filler intro sentence - Simplify deployment rollback logic - Remove verbose code comments Co-Authored-By: Claude Opus 4.5 <[email protected]>
- Rename to action-oriented heading - Remove redundant SDK examples (CLI only) - Remove 'Integrate with LLMs' (covered earlier) - Fix broken anchor link to delete section - Simplify Git section, remove 'Bad' example Co-Authored-By: Claude Opus 4.5 <[email protected]>
Some linked pages are still drafts. Will restore when ready. Co-Authored-By: Claude Opus 4.5 <[email protected]>
Contributor
CLI Documentation Generator
📚 Commands documented
|
Contributor
Preview Deployment
Commit: |
Contributor
E2E Test Results✅ Tests success Ran against: https://pr-107-superfly-sprites-docs.fly.dev |
Contributor
Lighthouse Results |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Rewrites the Checkpoints concept doc to follow our writing style guide and fix technical inaccuracies.
sprite restore→sprite checkpoint restore/.sprite/llm.txtis read-only docs, not writabletypefield, notstatusBefore merging
draft: truefrom frontmatter when ready to publish🤖 Generated with Claude Code