Skip to content

docs: add user-facing documentation for state backends (git-notes, orphan-branch) #995

Closed

Description

@tamirdresher

Squad has git-notes and orphan-branch state backends (shipped in PR #830). Fully implemented and tested (30+ tests) but no user-facing docs exist.

Needs:

  1. What state backends are and why (state survives branch switches, no diff pollution)
  2. Three options: worktree (default), git-notes, orphan
  3. How to configure: .squad/config.json or --state-backend CLI flag
  4. Priority chain: CLI > config > default
  5. Fallback behavior

Where: README SDK section, docs/features/state-backends.md, CLI help text.

Related: state-backend.ts, test/state-backend.test.ts, PR #810 (closed, folded into #830)

Activity

  1. added a commit that references this issue on Apr 17, 2026
    7a5b180
  2. added a commit that references this issue on Apr 21, 2026
    2981631
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or improvement

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions