Skip to content

Rewrite and publish Services concept page for rc43#183

Open
kcmartin wants to merge 1 commit into
mainfrom
docs/rewrite-services-concept
Open

Rewrite and publish Services concept page for rc43#183
kcmartin wants to merge 1 commit into
mainfrom
docs/rewrite-services-concept

Conversation

@kcmartin
Copy link
Copy Markdown
Collaborator

@kcmartin kcmartin commented Jun 2, 2026

Rewrites the Services concept page (/concepts/services) to match what rc43 actually ships, removes the draft flag, and adds the page to the Concepts sidebar group.

What changed

  • Replaced the raw sprite-env curl socket examples with the sprite-env services subcommands (create, start, stop, restart, signal, delete) and their flags (--env, --dir, --needs, --http-port, --duration)
  • Documented --http-port: URL routing to the service's port, auto-start on incoming requests, and the one-HTTP-service-per-Sprite constraint
  • Fixed log guidance: service output goes to /.sprite/logs/services/<name>.log; removed the journalctl/syslog advice (Sprites don't run systemd)
  • Added a lifecycle section covering warm wake vs. cold boot vs. crash vs. explicit stop, and clarified that services don't keep a Sprite from pausing
  • Replaced the Services vs. Detachable Sessions table with a Services / Sessions / Tasks comparison that links to Keeping a Sprite Running
  • Related-doc cards now only link to published pages; the API reference link points to https://sprites.dev/api/sprites/services
  • Removed draft: true and added Services to the Concepts sidebar, after Connectors

Verification

Every command and output sample on the page was run against an rc43 Sprite, including crash recovery (restart_count), sticky-stop vs. signal-restart behavior, the 409 on a second HTTP service, and startup-failure log output. The site builds cleanly and the sidebar entry renders on all pages.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jun 2, 2026

Preview Deployment

Name URL
Preview https://pr-183-superfly-sprites-docs.fly.dev

Commit: a10754f

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jun 2, 2026

E2E Test Results

✅ Tests success

Ran against: https://pr-183-superfly-sprites-docs.fly.dev

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jun 2, 2026

Lighthouse Results

URL Performance Accessibility Best Practices SEO
/ 🟠 82 🟢 100 🟢 96 🟢 100
/concepts/services/ 🟢 97 🟢 100 🟢 100 🟢 100

Replace raw socket API examples with the sprite-env services CLI,
document --http-port routing and auto-start, fix log guidance
(no journalctl; logs live in /.sprite/logs/services/), and add a
Services/Sessions/Tasks comparison. All examples verified against
an rc43 Sprite.

Removes the draft flag and adds Services to the Concepts sidebar
group.
@kcmartin kcmartin force-pushed the docs/rewrite-services-concept branch from 82bab55 to a216e15 Compare June 2, 2026 18:48
@kcmartin kcmartin changed the title Rewrite Services concept page for rc43 Rewrite and publish Services concept page for rc43 Jun 2, 2026
@kcmartin kcmartin requested review from aezell, jbellerb and vaurdan June 2, 2026 18:52
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