docs: add navigation links and docs landing page

SimplyLiz · SimplyLiz · commit 7f2ab7ab17dc · 2026-02-24T14:01:27.000+01:00
Add back-to-README and docs index links to all 9 pages.
Add docs/README.md as landing page for GitHub browsing.
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,15 @@
+# Documentation
+
+[Back to README](../README.md)
+
+| Page | Description |
+| ---- | ----------- |
+| [API Reference](api-reference.md) | All exports, types, options, and result fields |
+| [Compression Pipeline](compression-pipeline.md) | How compression works: classify, dedup, merge, summarize, guard |
+| [Deduplication](deduplication.md) | Exact + fuzzy dedup algorithms, tuning thresholds |
+| [Token Budget](token-budget.md) | Budget-driven compression, binary search, custom tokenizers |
+| [LLM Integration](llm-integration.md) | Provider examples: Claude, OpenAI, Gemini, Grok, Ollama |
+| [Round-trip](round-trip.md) | Lossless compress/uncompress, VerbatimMap, atomicity |
+| [Provenance](provenance.md) | `_cce_original` metadata, summary_id, parent_ids |
+| [Preservation Rules](preservation-rules.md) | What gets preserved, classification tiers, code-aware splitting |
+| [Benchmarks](benchmarks.md) | Running benchmarks, LLM comparison, interpreting results |
diff --git a/docs/api-reference.md b/docs/api-reference.md
@@ -1,5 +1,7 @@
 # API Reference
 
+[Back to README](../README.md) | [All docs](README.md)
+
 Complete reference for all exports from `context-compression-engine`.
 
 ## Exports
diff --git a/docs/benchmarks.md b/docs/benchmarks.md
@@ -1,5 +1,7 @@
 # Benchmarks
 
+[Back to README](../README.md) | [All docs](README.md)
+
 Running benchmarks, interpreting results, and comparing compression methods.
 
 ## Running tests
diff --git a/docs/compression-pipeline.md b/docs/compression-pipeline.md
@@ -1,5 +1,7 @@
 # Compression Pipeline
 
+[Back to README](../README.md) | [All docs](README.md)
+
 How `compress()` processes messages from start to finish.
 
 ## Pipeline overview
diff --git a/docs/deduplication.md b/docs/deduplication.md
@@ -1,5 +1,7 @@
 # Deduplication
 
+[Back to README](../README.md) | [All docs](README.md)
+
 Exact and fuzzy duplicate detection for repeated content in long conversations.
 
 ## Why dedup
diff --git a/docs/llm-integration.md b/docs/llm-integration.md
@@ -1,5 +1,7 @@
 # LLM Integration
 
+[Back to README](../README.md) | [All docs](README.md)
+
 Plug any LLM into the compression engine for semantic summarization.
 
 ## Summarizer interface
diff --git a/docs/preservation-rules.md b/docs/preservation-rules.md
@@ -1,5 +1,7 @@
 # Preservation Rules
 
+[Back to README](../README.md) | [All docs](README.md)
+
 What gets preserved, what gets compressed, and why.
 
 ## Rule priority
diff --git a/docs/provenance.md b/docs/provenance.md
@@ -1,5 +1,7 @@
 # Provenance
 
+[Back to README](../README.md) | [All docs](README.md)
+
 Metadata tracking for compressed messages.
 
 ## `_cce_original` metadata
diff --git a/docs/round-trip.md b/docs/round-trip.md
@@ -1,5 +1,7 @@
 # Round-trip Compression
 
+[Back to README](../README.md) | [All docs](README.md)
+
 Lossless compress/uncompress with the verbatim store.
 
 ## The lossless guarantee
diff --git a/docs/token-budget.md b/docs/token-budget.md
@@ -1,5 +1,7 @@
 # Token Budget
 
+[Back to README](../README.md) | [All docs](README.md)
+
 Automatically find the least compression needed to fit a target token count.
 
 ## How it works
