spacedriveapp / spacedriveapp/spacebot

docs(memory): align compaction docs with persistence-branch memory extraction

Open Beginner friendly
#569 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
2.4k
Forks
367
PR merge metrics
No merged PRs in 30d

Description

Problem

The implemented compactor behavior and the public docs disagree.

Current runtime behavior:

  • The compactor is context management only.
  • It runs a one-turn summarization worker.
  • It has no tool server.
  • It does not receive memory_save.
  • Durable memory extraction is handled by memory persistence branches and explicit memory tools elsewhere.

Stale docs still describe the old model where the compaction agent extracts memories using memory_save.

Files to update

  • docs/content/docs/(core)/compaction.mdx
  • docs/content/docs/(core)/memory.mdx
  • docs/content/docs/(features)/tools.mdx
  • src/agent/compactor.rs comments, if still stale
  • Design docs only if they are not being changed by an active working-memory PR

Desired invariant

Compaction is context management only.

The compactor watches context size, removes older turns, asks a one-turn LLM worker for a concise summary, and injects that summary into history.

It does not receive memory tools and does not write durable memories.

Durable memory extraction happens through branches, ingestion, cortex, and silent memory persistence branches. Working-memory events provide temporal signals that can trigger persistence earlier.

Suggested verification

rg -n "compactor.*memory_save|memory_save.*compactor|Extract memories|max_turns\\(10\\)|compaction agent has access" docs src prompts
just gate-pr

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the listed compaction.mdx, memory.mdx, and tools.mdx files, then inspect comments in src/agent/compactor.rs. Run the provided rg command to find stale memory_save and compaction-agent wording, while checking whether design docs are covered by an active working-memory PR. Done means the docs consistently describe compaction as context-only and just gate-pr passes.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
76/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.