Skip to content

docs: coordinator compaction recovery and restraint rules (#934) - #953

Merged
bradygaster merged 1 commit into
devfrom
squad/934-coordinator-compaction-docs
Apr 11, 2026
Merged

bradygaster merged 1 commit into
devfrom
squad/934-coordinator-compaction-docs

Conversation

@diberry

@diberry diberry commented Apr 10, 2026

Copy link
Copy Markdown
Contributor

Closes #934

Adds three reference documentation pages explaining coordinator features from PR #859:

  • coordinator-restraint.md — Documents the 6 restraint rules that balance Coordinator's eager execution with respectful boundaries
  • result-persistence.md — Documents mandatory archival of agent results to orchestration log before context expires
  • compaction-recovery.md — Documents session state checkpoint mechanism for recovering from context compaction

Each page includes:

  • Clear definition of the feature
  • Observable behavior examples
  • File formats and examples
  • Links to related concepts

@diberry
diberry marked this pull request as ready for review April 10, 2026 14:59
Copilot AI review requested due to automatic review settings April 10, 2026 14:59

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Adds reference documentation pages describing Coordinator behaviors around result persistence, restraint rules, and compaction recovery.

Changes:

  • Added a new reference page documenting “result persistence” and orchestration log usage.
  • Added a new reference page documenting the Coordinator’s 6 restraint rules.
  • Added a new reference page documenting “compaction recovery” via a session state checkpoint.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 8 comments.

File Description
docs/src/content/docs/reference/result-persistence.md New reference doc describing how agent results are archived to orchestration logs.
docs/src/content/docs/reference/coordinator-restraint.md New reference doc describing 6 restraint rules for Coordinator behavior after dispatch.
docs/src/content/docs/reference/compaction-recovery.md New reference doc describing recovery behavior when conversation context is compacted.

Closes #934

Adds three reference documentation pages:
- coordinator-restraint.md: 6 restraint rules to prevent over-managing agents
- result-persistence.md: mandatory archival of agent results to orchestration log
- compaction-recovery.md: session state checkpoint mechanism for context recovery

Addresses all requirements from issue #934 per PR #859.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@diberry
diberry force-pushed the squad/934-coordinator-compaction-docs branch from d01cb38 to ae7b0d7 Compare April 10, 2026 16:02
@diberry

diberry commented Apr 10, 2026

Copy link
Copy Markdown
Contributor Author

✅ CI passes on fork — diberry/squad PR #150 (all checks green). Copilot review feedback addressed. Ready for human review.

@bradygaster
bradygaster merged commit dfb3589 into dev Apr 11, 2026
tamirdresher pushed a commit that referenced this pull request Apr 21, 2026
Closes #934

Adds three reference documentation pages:
- coordinator-restraint.md: 6 restraint rules to prevent over-managing agents
- result-persistence.md: mandatory archival of agent results to orchestration log
- compaction-recovery.md: session state checkpoint mechanism for context recovery

Addresses all requirements from issue #934 per PR #859.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
SabreSE pushed a commit to SabreSE/squad that referenced this pull request May 7, 2026
PR github#1023 merged insider into main, but insider was behind on docs changes
that had already landed on main via dev (PRs github#989, github#953, github#955, github#956, github#906).
The merge resolution picked insider's older versions, reverting 25 docs files.

This restores all affected files from dev:
- David Pine's human-led productivity emphasis (PR github#989)
- Cross-links between related documentation (PR github#956)
- Compaction recovery, coordinator restraint, result persistence refs
- Teams async adapter migration guide
- State backends feature doc
- Search/Sidebar component updates
- Landing page content

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@bradygaster
bradygaster deleted the squad/934-coordinator-compaction-docs branch August 8, 2026 08:43
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.

docs: coordinator compaction recovery and restraint rules (#859)

3 participants