Skip to content

Document serve mode and an aiosendspin bump checklist in AGENTS.md - #311

Draft
wildekek wants to merge 1 commit into
Sendspin:mainfrom
wildekek:docs/agents-serve-mode
Draft

wildekek wants to merge 1 commit into
Sendspin:mainfrom
wildekek:docs/agents-serve-mode

Conversation

@wildekek

Copy link
Copy Markdown
Contributor

What does this implement/fix?

AGENTS.md (which CLAUDE.md links to) only described the TUI and the daemon. So the aiosendspin 10 bump in #305 was tested without sendspin serve, and Sendspin Party broke until #307 fixed it.

This adds serve mode to the guide:

  • Overview: the CLI has three modes, and serve mode runs on aiosendspin's server side, so it needs its own testing.
  • Architecture: a diagram of the serve/ package, from decoding and workers to SendspinPlayerServer and the sendspin-js web player.
  • File responsibilities: each file in sendspin/serve/, including PartyPairingStore, and the rule that the sendspin-js version pinned in web/app.js must speak the same protocol version as aiosendspin.
  • Key dependencies: sendspin-js and PyAV, and aiosendspin as both client and server.
  • Common tasks: sendspin serve --demo, plus a "Bumping aiosendspin" checklist covering the TUI, the daemon (including two servers), serve mode in a browser, and a grep of all of sendspin/ for changed APIs.

Documentation only; no code changes.

Related issue (if applicable):

Types of changes

  • Bugfix (non-breaking change which fixes an issue): bugfix
  • New feature (non-breaking change which adds functionality): new-feature
  • Enhancement to an existing feature: enhancement
  • Breaking change (changes CLI options, settings, hooks or the protocol in a way that is not backwards compatible): breaking-change
  • Refactor (no behavior change): refactor
  • Documentation only: documentation
  • Maintenance / chore: maintenance
  • CI / workflow change: ci
  • Dependencies bump: dependencies

🤖 Generated with Claude Code

The guide only described the TUI and daemon, so the aiosendspin 10 bump
was tested without `sendspin serve` and broke Sendspin Party (fixed in
Sendspin#307). Describe the serve package, its sendspin-js dependency, how to run
it, and a checklist that covers all three modes when aiosendspin changes.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@github-actions github-actions Bot added the documentation Changes only documentation label Oct 26, 2026

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Changes only documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant