Repository navigation
docs(memory): correct history compaction size and mechanism - #2324
Conversation
The docs said history.md is summarized at ~12 KB into a summary section. The code uses 15 KB, and squad nap (run by hand) moves older ## sections word for word to history-archive.md without summarizing. Fix the threshold, describe what squad nap actually does (history trim, log pruning, inbox merge, decision archival), separate it from asking an agent to summarize, and correct the --deep description, the /compact comparison and the cli.md tree. Closes github#2323
🛫 PR Readiness Check
PR Scope: 🔧 Infrastructure
|
| Status | Check | Details |
|---|---|---|
| ❌ | Single commit | 3 commits — consider squashing before review |
| ✅ | Not in draft | Ready for review |
| ✅ | Branch up to date | Up to date with dev |
| ❌ | Copilot review | No Copilot review yet — it may still be processing |
| ✅ | Changeset present | No source files changed — changeset not required |
| ✅ | Scope clean | No .squad/ or docs/proposals/ files |
| ✅ | No merge conflicts | No merge conflicts |
| ✅ | Copilot threads resolved | No Copilot review threads |
| ❌ | CI passing | 11 check(s) still running |
Files Changed (4 files, +43 −27)
| File | +/− |
|---|---|
docs/src/content/docs/concepts/memory-and-knowledge.md |
+12 −7 |
docs/src/content/docs/features/context-hygiene.md |
+17 −11 |
docs/src/content/docs/features/memory.md |
+7 −2 |
docs/src/content/docs/reference/cli.md |
+7 −7 |
Total: +43 −27
This check runs automatically on every push. Fix any ❌ items and push again.
See CONTRIBUTING.md and PR Requirements for details.
🟢 Impact Analysis — PR #2324Risk tier: 🟢 LOW 📊 Summary
🎯 Risk Factors
📦 Modules Affecteddocs (4 files)
This report is generated automatically for every PR. See #733 for details. |
|
Thanks Jose! Confirmed against packages/squad-cli/src/cli/core/nap.ts:49 (HISTORY_THRESHOLD = 15 * 1024) and compressHistory ( |
What
Docs only. This fixes how four pages describe history compaction: the size (15 KB, not ~12 KB) and the mechanism (
squad napmoves old sections word for word and doesn't summarize; nothing runs on its own).Why
Closes #2323
The docs said a
history.mdover "~12KB" gets "archived into a summary section". The code usesHISTORY_THRESHOLD = 15 * 1024(nap.ts:49), andsquad nap, run by hand, keeps the newest##sections and moves the older ones verbatim tohistory-archive.md.context-hygiene.mdalso called a nap "the same as running/compact" and said "take a nap" makes each agent summarize.How
concepts/memory-and-knowledge.md:squad napdoes and that asking the coordinator for a summary is a separate, AI-driven job.squad nap, and decisions above 20 KB when you run it.features/memory.md: the same correction for the history section.features/context-hygiene.md:squad nap./napis the command in Squad's interactive shell./compactbelongs to Copilot CLI and only shortens the chat.--deepkeeps 3 sections instead of 5.reference/cli.md: the--deeprow, and the.squad/tree now showshistory-archive.mdinside each agent's folder.I kept the wording true whether or not #2322 lands: the pages describe Scribe as its charter does (it doesn't touch histories) and don't rely on the old after-agent prompt.
Out of scope, and worth separate issues later:
squad nap's history trim is a no-op on the usual## Learnings+###layout, and unlike decision archival it has no ignored-destination check.PR Readiness Checklist
Branch & Commit
dev(notmain)dev(9d7dff8)Build & Test
markdownlint-cli2andcspellpass on the changed pagesfeatures/memory.mdDocs
Breaking Changes
None.
Waivers
None.