Skip to content

Commit 51f1fc2

Browse files
chopratejasclaude
andcommitted
Fix all broken docs links in README after docs migration (#161)
Commit 911eb85 migrated docs from flat .md files to a Fumadocs site under docs/content/docs/*.mdx but left the README pointing at the old paths. Update all 30+ links to their new locations, remove rows for docs that were deleted without replacement (CLI reference, persistent installs, latency benchmarks), and consolidate Docker-native install and TypeScript SDK links into their new homes. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 7c91fe1 commit 51f1fc2

File tree

1 file changed

+32
-35
lines changed

1 file changed

+32
-35
lines changed

README.md

Lines changed: 32 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -155,9 +155,9 @@ OPENAI_BASE_URL=http://localhost:8787/v1 your-app
155155
Use `token` mode for short/medium sessions where raw compression savings matter most.
156156
Use `cache` mode for long-running chats where preserving prior-turn bytes improves provider cache reuse.
157157

158-
Works with any language, any tool, any framework. **[Proxy docs](docs/proxy.md)**
158+
Works with any language, any tool, any framework. **[Proxy docs](docs/content/docs/proxy.mdx)**
159159

160-
Prefer Docker as the runtime provider? See **[Docker-native install](docs/docker-install.md)**. Want Headroom to stay up in the background? See **[Persistent installs](docs/persistent-installs.md)**.
160+
Prefer Docker as the runtime provider? See **[Installation — Docker](docs/content/docs/installation.mdx)**.
161161

162162
### Coding agents — one command
163163

@@ -189,15 +189,15 @@ summary = ctx.get("research") # Agent B reads (~80% smaller)
189189
full = ctx.get("research", full=True) # Agent B gets original if needed
190190
```
191191

192-
Compress what moves between agents — any framework. **[SharedContext Guide](docs/shared-context.md)**
192+
Compress what moves between agents — any framework. **[SharedContext Guide](docs/content/docs/shared-context.mdx)**
193193

194194
### MCP Tools (Claude Code, Cursor)
195195

196196
```bash
197197
headroom mcp install && claude
198198
```
199199

200-
Gives your AI tool three MCP tools: `headroom_compress`, `headroom_retrieve`, `headroom_stats`. **[MCP Guide](docs/mcp.md)**
200+
Gives your AI tool three MCP tools: `headroom_compress`, `headroom_retrieve`, `headroom_stats`. **[MCP Guide](docs/content/docs/mcp.mdx)**
201201

202202
### Drop into your existing stack
203203

@@ -219,7 +219,7 @@ Gives your AI tool three MCP tools: `headroom_compress`, `headroom_retrieve`, `h
219219
| **Codex / Aider** | Wrap | `headroom wrap codex` or `headroom wrap aider` |
220220
| **Always-on local proxy** | Persistent install | `headroom install apply --preset persistent-service --providers auto` |
221221

222-
**[Full Integration Guide](docs/integration-guide.md)** | **[TypeScript SDK](docs/typescript-sdk.md)**
222+
**[Full Integration Guide](docs/content/docs/index.mdx)**
223223

224224
---
225225

@@ -292,7 +292,7 @@ python -m headroom.evals suite --tier 1 -o eval_results/
292292
python -m headroom.evals suite --tier 1 --ci
293293
```
294294

295-
Full methodology: [Benchmarks](docs/benchmarks.md) | [Evals Framework](headroom/evals/README.md)
295+
Full methodology: [Benchmarks](docs/content/docs/benchmarks.mdx) | [Evals Framework](headroom/evals/README.md)
296296

297297
---
298298

@@ -317,7 +317,7 @@ headroom wrap claude --memory # Claude with persistent memory
317317
headroom wrap codex --memory # Codex shares the SAME memory store
318318
```
319319

320-
Claude saves a fact, Codex reads it back. All agents sharing one proxy share one memory — project-scoped, user-isolated, with agent provenance tracking and automatic deduplication. No SDK changes needed. **[Memory docs](docs/memory.md)**
320+
Claude saves a fact, Codex reads it back. All agents sharing one proxy share one memory — project-scoped, user-isolated, with agent provenance tracking and automatic deduplication. No SDK changes needed. **[Memory docs](docs/content/docs/memory.mdx)**
321321

322322
### Failure Learning
323323

@@ -327,7 +327,7 @@ headroom learn --apply # Write learnings to agent-native files
327327
headroom learn --agent codex --all # Analyze all Codex sessions
328328
```
329329

330-
Plugin-based: reads conversation history from Claude Code, Codex, or Gemini CLI. Finds failure patterns, correlates with successes, writes corrections to CLAUDE.md / AGENTS.md / GEMINI.md. External plugins via entry points. **[Learn docs](docs/learn.md)**
330+
Plugin-based: reads conversation history from Claude Code, Codex, or Gemini CLI. Finds failure patterns, correlates with successes, writes corrections to CLAUDE.md / AGENTS.md / GEMINI.md. External plugins via entry points. **[Learn docs](docs/content/docs/failure-learning.mdx)**
331331

332332
<p align="center">
333333
<img src="headroom_learn.gif" alt="headroom learn demo" width="800">
@@ -405,24 +405,24 @@ Context compression is a new space. Here's how the approaches differ:
405405
Originals are in the Compressed Store — nothing is thrown away.
406406
```
407407

408-
**Overhead**: 15-200ms compression latency (net positive for Sonnet/Opus). Full data: [Latency Benchmarks](docs/LATENCY_BENCHMARKS.md)
408+
**Overhead**: 15-200ms compression latency (net positive for Sonnet/Opus). Full data: [Benchmarks](docs/content/docs/benchmarks.mdx)
409409

410410
---
411411

412412
## Integrations
413413

414414
| Integration | Status | Docs |
415415
|-------------|--------|------|
416-
| `headroom wrap claude/copilot/codex/aider/cursor` | **Stable** | [Proxy Docs](docs/proxy.md) |
417-
| `compress()` — one function | **Stable** | [Integration Guide](docs/integration-guide.md) |
418-
| `SharedContext` — multi-agent | **Stable** | [SharedContext Guide](docs/shared-context.md) |
419-
| LiteLLM callback | **Stable** | [Integration Guide](docs/integration-guide.md#litellm) |
420-
| ASGI middleware | **Stable** | [Integration Guide](docs/integration-guide.md#asgi-middleware) |
421-
| Proxy server | **Stable** | [Proxy Docs](docs/proxy.md) |
422-
| Agno | **Stable** | [Agno Guide](docs/agno.md) |
423-
| MCP (Claude Code, Cursor, etc.) | **Stable** | [MCP Guide](docs/mcp.md) |
424-
| Strands | **Stable** | [Strands Guide](docs/strands.md) |
425-
| LangChain | **Stable** | [LangChain Guide](docs/langchain.md) |
416+
| `headroom wrap claude/copilot/codex/aider/cursor` | **Stable** | [Proxy Docs](docs/content/docs/proxy.mdx) |
417+
| `compress()` — one function | **Stable** | [Integration Guide](docs/content/docs/index.mdx) |
418+
| `SharedContext` — multi-agent | **Stable** | [SharedContext Guide](docs/content/docs/shared-context.mdx) |
419+
| LiteLLM callback | **Stable** | [LiteLLM Guide](docs/content/docs/litellm.mdx) |
420+
| ASGI middleware | **Stable** | [Integration Guide](docs/content/docs/index.mdx) |
421+
| Proxy server | **Stable** | [Proxy Docs](docs/content/docs/proxy.mdx) |
422+
| Agno | **Stable** | [Agno Guide](docs/content/docs/agno.mdx) |
423+
| MCP (Claude Code, Cursor, etc.) | **Stable** | [MCP Guide](docs/content/docs/mcp.mdx) |
424+
| Strands | **Stable** | [Strands Guide](docs/content/docs/strands.mdx) |
425+
| LangChain | **Stable** | [LangChain Guide](docs/content/docs/langchain.mdx) |
426426
| **OpenClaw** | **Stable** | [OpenClaw plugin](#openclaw-plugin) |
427427

428428
---
@@ -521,23 +521,20 @@ Python 3.10+
521521

522522
| | |
523523
|---|---|
524-
| [Integration Guide](docs/integration-guide.md) | LiteLLM, ASGI, compress(), proxy |
525-
| [Proxy Docs](docs/proxy.md) | Proxy server configuration |
526-
| [Architecture](docs/ARCHITECTURE.md) | How the pipeline works |
527-
| [CCR Guide](docs/ccr.md) | Reversible compression |
528-
| [Benchmarks](docs/benchmarks.md) | Accuracy validation |
529-
| [Latency Benchmarks](docs/LATENCY_BENCHMARKS.md) | Compression overhead & cost-benefit analysis |
530-
| [Limitations](docs/LIMITATIONS.md) | When compression helps, when it doesn't |
524+
| [Integration Guide](docs/content/docs/index.mdx) | LiteLLM, ASGI, compress(), proxy |
525+
| [Proxy Docs](docs/content/docs/proxy.mdx) | Proxy server configuration |
526+
| [Architecture](docs/content/docs/architecture.mdx) | How the pipeline works |
527+
| [CCR Guide](docs/content/docs/ccr.mdx) | Reversible compression |
528+
| [Benchmarks](docs/content/docs/benchmarks.mdx) | Accuracy validation |
529+
| [Limitations](docs/content/docs/limitations.mdx) | When compression helps, when it doesn't |
531530
| [Evals Framework](headroom/evals/README.md) | Prove compression preserves accuracy |
532-
| [Memory](docs/memory.md) | Cross-agent persistent memory with provenance + dedup |
533-
| [Agno](docs/agno.md) | Agno agent framework |
534-
| [MCP](docs/mcp.md) | Context engineering toolkit (compress, retrieve, stats) |
535-
| [SharedContext](docs/shared-context.md) | Compressed inter-agent context sharing |
536-
| [Learn](docs/learn.md) | Plugin-based failure learning (Claude, Codex, Gemini, extensible) |
537-
| [CLI Reference](docs/cli.md) | Complete command surface, help output, and Docker parity matrix |
538-
| [Docker-Native Install](docs/docker-install.md) | Host wrapper install, compose support, and Docker runtime behavior |
539-
| [Persistent Installs](docs/persistent-installs.md) | Service/task/docker deployment models and provider scopes |
540-
| [Configuration](docs/configuration.md) | All options |
531+
| [Memory](docs/content/docs/memory.mdx) | Cross-agent persistent memory with provenance + dedup |
532+
| [Agno](docs/content/docs/agno.mdx) | Agno agent framework |
533+
| [MCP](docs/content/docs/mcp.mdx) | Context engineering toolkit (compress, retrieve, stats) |
534+
| [SharedContext](docs/content/docs/shared-context.mdx) | Compressed inter-agent context sharing |
535+
| [Learn](docs/content/docs/failure-learning.mdx) | Plugin-based failure learning (Claude, Codex, Gemini, extensible) |
536+
| [Installation](docs/content/docs/installation.mdx) | pip, npm, Docker install methods |
537+
| [Configuration](docs/content/docs/configuration.mdx) | All options |
541538

542539
---
543540

0 commit comments

Comments
 (0)