Improve Working with Sprites page #75
Merged
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
Added comprehensive improvements to make the guide more approachable and useful for new users: - Lifecycle: Wake-up behavior, state persistence details, and cold start timing - Interactive Sessions: How to terminate sessions and detachable session behavior - Environment: Base OS info, version checking commands, and storage recommendations - HTTP Access: Complete examples, auth modes, URL vs port forwarding comparison - Port Forwarding: JS SDK examples, stopping forwarding, port conflict handling - Checkpoints: When to use, best practices, limitations, and storage implications - Error Handling: Common scenarios (connection, timeout, quota errors) with fixes - Cleanup: Irreversibility warnings and best practices before destroying - Mount Filesystem: Prerequisites for SSHFS, unmounting, and security notes Kept tone friendly and approachable while staying concise (176 lines added). Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Added comprehensive section at the start of working-with-sprites explaining the three main ways to interact with Sprites: - sprite exec: One-off commands and automation - sprite console: Interactive shell sessions - sprite exec -detachable + attach: Long-running processes Includes when to use each, how they behave, practical examples, and a quick decision guide. This is fundamental behavior that users need to understand. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Replace comprehensive documentation with a shorter, more focused guide: - Reorganize around the three main interaction modes (exec, console, detachable) - Simplify lifecycle and persistence explanation - Consolidate networking section with practical examples - Move advanced topics (checkpoints, SSHFS, errors) to "Going Deeper" section - Remove SDK examples (will be in separate reference page) Reduces page from ~1200 lines to ~290 lines while keeping essential information. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
CLI Documentation Generator
📚 Commands documented
|
Preview Deployment
Commit: |
E2E Test Results❌ Tests failure Ran against: https://pr-75-superfly-sprites-docs.fly.dev |
These are valid terms flagged by Vale linter: - df: Unix command for disk free - Unmount: valid verb for unmounting filesystems Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
injoongy
approved these changes
Jan 15, 2026
injoongy
left a comment
injoongy
left a comment
There was a problem hiding this comment.
One small note, but otherwise looks good 👍🏻
Co-authored-by: Injoong Yoon <27440940+injoongy@users.noreply.github.com>
Checkpoints are a core safety feature, not an advanced topic. Users should know about them before making risky changes or destroying sprites. Moved from "Going Deeper" to its own main section after "Managing Sprites". Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
swilson-fly
reviewed
Jan 16, 2026
swilson-fly
reviewed
Jan 16, 2026
swilson-fly
reviewed
Jan 16, 2026
- Link "Quickstart" to the quickstart page - Fix wording: detachable sessions prevent hibernation, not survive it - Fix URL domain: sprites.app not sprites.dev Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Replaces emoji checkmarks with styled SVG icons in working-with-sprites.mdx Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
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
Test plan
SDK Tests for Working with Sprites Examples
Tested the CLI examples from this page using the JavaScript and Elixir SDKs against the live Sprites API:
Tested with JavaScript SDK (@fly/sprites@0.0.1):
Tested with Elixir SDK (github.com/superfly/sprites-ex):
Note: Checkpoint restore works but the sprite needs a moment to wake up afterward. Commands issued immediately after restore may timeout.