Skip to content

Add Keeping a Sprite Running guide#178

Merged
kcmartin merged 2 commits into
mainfrom
docs/keeping-sprites-running
May 14, 2026
Merged

Add Keeping a Sprite Running guide#178
kcmartin merged 2 commits into
mainfrom
docs/keeping-sprites-running

Conversation

@kcmartin
Copy link
Copy Markdown
Collaborator

@kcmartin kcmartin commented May 13, 2026

New "Keeping a Sprite Running" guide in Getting Started.

Documents the Tasks API as the supported mechanism for keeping a Sprite from pausing while an AI agent or other long-lived process is doing work. Covers the warm/cold lifecycle, when to use a Task vs a Service, the heartbeat pattern, and full API reference.

Adds a sidebar entry between "Working with Sprites" and "Sprite Maintenance".

Documents the Tasks API as the supported way to hold a Sprite open
while an AI agent or other long-lived process is doing work. Covers
the warm/cold lifecycle, when to use a Task vs a Service, the
heartbeat pattern, and full API reference.
@kcmartin kcmartin force-pushed the docs/keeping-sprites-running branch from 549c05f to 1d4134f Compare May 13, 2026 20:15
@kcmartin kcmartin requested a review from jbellerb May 13, 2026 20:28
Copy link
Copy Markdown
Contributor

@jbellerb jbellerb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The hidden services docs are the only real blocker.

Comment thread src/content/docs/keeping-sprites-running.mdx Outdated
Comment thread src/content/docs/keeping-sprites-running.mdx Outdated
Comment thread src/content/docs/keeping-sprites-running.mdx Outdated
Comment thread src/content/docs/keeping-sprites-running.mdx Outdated
- Clarify the Tasks API is for background agents, not foreground sessions
- Drop link to the draft Services concept page; add a brief inline
  definition so readers have an anchor without leaving the guide
- Tighten the "forget to clean up" bullet per reviewer suggestion
- Lead the heartbeat section with the 1-hour task cap that motivates
  the pattern
@kcmartin
Copy link
Copy Markdown
Collaborator Author

@jbellerb Thanks for reviewing! I addressed your comments, if you wouldn't mind a quick re-check

@kcmartin kcmartin requested a review from jbellerb May 13, 2026 23:52
@kcmartin kcmartin merged commit 887cf9a into main May 14, 2026
3 of 5 checks passed
@kcmartin kcmartin deleted the docs/keeping-sprites-running branch May 14, 2026 23:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants