From df31f9f383c689b73ab3da3c6c391916ada65dd0 Mon Sep 17 00:00:00 2001 From: Bhavya Chopra <64201249+bhavyachopra99@users.noreply.github.com> Date: Fri, 26 Jun 2026 00:56:48 +0530 Subject: [PATCH] docs: retire IntelligentContext from README and installation guide README and installation.mdx still marketed IntelligentContext and RollingWindow history-dropping after PR-B1 moved the pipeline to live-zone-only compression. Replace with the current story: compress new bytes, preserve frozen prefix, never drop history. Co-authored-by: Cursor --- README.md | 4 ++-- docs/content/docs/installation.mdx | 4 +++- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 104c587d9..12cc7a4ba 100644 --- a/README.md +++ b/README.md @@ -271,7 +271,7 @@ Platform support note: macOS auth reuse via Copilot CLI Keychain storage has bee - **Kompress-base** — our HuggingFace model, trained on agentic traces. - **Image compression** — 40–90% reduction via trained ML router. - **CacheAligner** — stabilizes prefixes so Anthropic/OpenAI KV caches actually hit. -- **IntelligentContext** — score-based context fitting with learned importance. +- **Live-zone compression** — compresses only new bytes (fresh tool output, latest turn); frozen prefix stays byte-identical so provider cache is not busted. History is never dropped. - **CCR** — reversible compression; LLM retrieves originals on demand. - **Cross-agent memory** — shared store, agent provenance, auto-dedup. - **SharedContext** — compressed context passing across multi-agent workflows. @@ -286,7 +286,7 @@ Headroom exposes one stable request lifecycle across `compress()`, the SDK, and `Setup` → `Pre-Start` → `Post-Start` → `Input Received` → `Input Cached` → `Input Routed` → `Input Compressed` → `Input Remembered` → `Pre-Send` → `Post-Send` → `Response Received` -- **Transforms** do the work: CacheAligner, ContentRouter, SmartCrusher, CodeCompressor, Kompress-base, IntelligentContext / RollingWindow. +- **Transforms** do the work: CacheAligner → ContentRouter → SmartCrusher / CodeCompressor / Kompress-base (live-zone only; IntelligentContext and RollingWindow were retired in PR-B1). - **Pipeline extensions** observe or customize lifecycle stages via `on_pipeline_event(...)`. - **Compression hooks** sit alongside the canonical lifecycle as an additional extension seam. - **Proxy extensions** remain the server/app integration seam for ASGI middleware, routes, and startup policy. diff --git a/docs/content/docs/installation.mdx b/docs/content/docs/installation.mdx index 162cc2a91..5a4535ac1 100644 --- a/docs/content/docs/installation.mdx +++ b/docs/content/docs/installation.mdx @@ -26,7 +26,9 @@ using a newer Python, force a supported interpreter. pip install headroom-ai ``` -The core package includes the `compress()` function, SmartCrusher, CacheAligner, and IntelligentContext. No heavy dependencies. +The core package includes `compress()`, SmartCrusher, CacheAligner, and live-zone ContentRouter compression. No heavy dependencies. + +> **Note:** IntelligentContext / RollingWindow (score-based history dropping) were retired in PR-B1. Headroom compresses fresh tool output and new turns only — it does not drop conversation history. ### Extras