Skip to content

Commit 8cd6dd4

Browse files
docs: update README with product vision and roadmap (#34)
- Update tagline to 'context intelligence layer for AI agents' - Add Roadmap section with three pillars: Context Memory, Code Intelligence, Platform - Update architecture diagram to show planned components - Add API Endpoints table with SSE streaming - Update Use Cases with incident triage and code review - Update Integrations to reflect current state (MCP, Prometheus, OTEL) - Add links to playground, blog, and demo booking Co-authored-by: Ona <no-reply@ona.com>
1 parent d60b57f commit 8cd6dd4

File tree

1 file changed

+66
-16
lines changed

1 file changed

+66
-16
lines changed

README.md

Lines changed: 66 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@
88

99
[![Build with Ona](https://ona.com/build-with-ona.svg)](https://app.ona.com/#https://github.com/siddhant-k-code/distill)
1010

11-
**Reliable LLM outputs start with clean context.**
11+
**Context intelligence layer for AI agents.**
1212

13-
A reliability layer for LLM context. Deterministic deduplication that removes redundancy before it reaches your model.
13+
Deduplicates, compresses, and manages context across sessions - so your agents produce reliable, deterministic outputs. Today: a dedup pipeline with ~12ms overhead. Next: persistent context memory, code change impact graphs, and session-aware context windows.
1414

15-
Less redundant data. Lower costs. Faster responses. More efficient & deterministic results.
15+
Less redundant data. Lower costs. Faster responses. Deterministic results.
1616

1717
**[Learn more →](https://distill.siddhantkhare.com)**
1818

@@ -213,6 +213,16 @@ distill query # Test a query from command line
213213
distill config # Manage configuration files
214214
```
215215

216+
## API Endpoints
217+
218+
| Method | Path | Description |
219+
|--------|------|-------------|
220+
| POST | `/v1/dedupe` | Deduplicate chunks |
221+
| POST | `/v1/dedupe/stream` | SSE streaming dedup with per-stage progress |
222+
| POST | `/v1/retrieve` | Query vector DB with dedup (requires backend) |
223+
| GET | `/health` | Health check |
224+
| GET | `/metrics` | Prometheus metrics |
225+
216226
## Configuration
217227

218228
### Config File
@@ -465,21 +475,28 @@ KV cache for repeated context patterns (system prompts, tool definitions, boiler
465475

466476
```
467477
┌──────────────────────────────────────────────────────────────────────┐
468-
Your App
478+
│ Your App / Agent
469479
└──────────────────────────────────────────────────────────────────────┘
470480
471481
472482
┌──────────────────────────────────────────────────────────────────────┐
473483
│ Distill │
474484
│ │
485+
│ Dedup Pipeline (shipped) │
475486
│ ┌─────────┐ ┌─────────┐ ┌─────────┐ ┌──────────┐ ┌─────────┐ │
476487
│ │ Cache │→ │ Cluster │→ │ Select │→ │ Compress │→ │ MMR │ │
477488
│ │ check │ │ dedup │ │ best │ │ prune │ │ re-rank │ │
478489
│ └─────────┘ └─────────┘ └─────────┘ └──────────┘ └─────────┘ │
479490
│ <1ms 6ms <1ms 2ms 3ms │
480491
│ │
492+
│ Context Intelligence (planned) │
493+
│ ┌──────────────┐ ┌──────────────┐ ┌──────────────────────────┐ │
494+
│ │ Memory Store │ │ Impact Graph │ │ Session Context Windows │ │
495+
│ │ (#29) │ │ (#30) │ │ (#31) │ │
496+
│ └──────────────┘ └──────────────┘ └──────────────────────────┘ │
497+
│ │
481498
│ ┌──────────────────────────────────────────────────────────────┐ │
482-
│ │ /metrics (Prometheus) · distill.yaml · MCP server │ │
499+
│ │ /metrics (Prometheus) · OTEL tracing · MCP server │ │
483500
│ └──────────────────────────────────────────────────────────────┘ │
484501
└──────────────────────────────────────────────────────────────────────┘
485502
@@ -500,7 +517,38 @@ KV cache for repeated context patterns (system prompts, tool definitions, boiler
500517
- **Code Assistants** - Dedupe context from multiple files/repos
501518
- **RAG Pipelines** - Remove redundant chunks before LLM
502519
- **Agent Workflows** - Clean up tool outputs + memory + docs
503-
- **Enterprise** - Deterministic outputs for compliance
520+
- **Incident Triage** - Find similar past changes that caused outages
521+
- **Code Review** - Blast radius analysis for PRs
522+
- **Enterprise** - Deterministic outputs with source attribution
523+
524+
## Roadmap
525+
526+
Distill is evolving from a dedup utility into a context intelligence layer. Here's what's next:
527+
528+
### Context Memory
529+
530+
| Feature | Issue | Description |
531+
|---------|-------|-------------|
532+
| **Context Memory Store** | [#29](https://github.com/Siddhant-K-code/distill/issues/29) | Persistent, deduplicated memory across sessions. Write-time dedup, hierarchical decay (full text -> summary -> keywords -> evicted), token-budgeted recall. |
533+
| **Session Management** | [#31](https://github.com/Siddhant-K-code/distill/issues/31) | Stateful context windows for long-running agents. Push context incrementally, Distill keeps it deduplicated and within budget. |
534+
535+
### Code Intelligence
536+
537+
| Feature | Issue | Description |
538+
|---------|-------|-------------|
539+
| **Change Impact Graph** | [#30](https://github.com/Siddhant-K-code/distill/issues/30) | Dependency graph + co-change patterns from git history. "This PR changes auth/jwt.go - here's the blast radius." |
540+
| **Semantic Commit Analysis** | [#32](https://github.com/Siddhant-K-code/distill/issues/32) | Find similar past changes, predict incidents. "This diff is 82% similar to the one that caused outage #47." |
541+
542+
### Infrastructure
543+
544+
| Feature | Issue | Description |
545+
|---------|-------|-------------|
546+
| **Multi-Provider Embeddings** | [#33](https://github.com/Siddhant-K-code/distill/issues/33) | Ollama, Azure OpenAI, Cohere, HuggingFace. Swap providers via config. |
547+
| **Batch API** | [#11](https://github.com/Siddhant-K-code/distill/issues/11) | Async batch processing for large workloads. |
548+
| **Python SDK** | [#5](https://github.com/Siddhant-K-code/distill/issues/5) | `pip install distill-ai` with LangChain/LlamaIndex integrations. |
549+
| **OpenAPI Spec** | [#23](https://github.com/Siddhant-K-code/distill/issues/23) | Swagger UI at `/docs`, auto-generated client SDKs. |
550+
551+
See all open issues: [github.com/Siddhant-K-code/distill/issues](https://github.com/Siddhant-K-code/distill/issues)
504552
505553
## Why not just use an LLM?
506554
@@ -520,21 +568,21 @@ Use LLMs for reasoning. Use deterministic algorithms for reliability.
520568
521569
Works with your existing AI stack:
522570
523-
- **LLM Providers:** OpenAI, Anthropic
524-
- **Frameworks:** LangChain, LlamaIndex
525-
- **Vector DBs:** Pinecone, Qdrant, Weaviate, Chroma, pgvector
526-
- **Tools:** Cursor, Lovable, and more
571+
- **LLM Providers:** OpenAI, Anthropic (more via [#33](https://github.com/Siddhant-K-code/distill/issues/33))
572+
- **Frameworks:** LangChain, LlamaIndex (SDKs planned: [#5](https://github.com/Siddhant-K-code/distill/issues/5))
573+
- **Vector DBs:** Pinecone, Qdrant
574+
- **AI Assistants:** Claude Desktop, Cursor (via MCP)
575+
- **Observability:** Prometheus, Grafana, OpenTelemetry (Jaeger, Tempo)
527576
528577
## Contributing
529578
530-
Contributions welcome! Please read the contributing guidelines first.
579+
Contributions welcome! Check the [open issues](https://github.com/Siddhant-K-code/distill/issues) for things to work on.
531580
532581
```bash
533-
# Run tests
534-
go test ./...
535-
536-
# Build
582+
git clone https://github.com/Siddhant-K-code/distill.git
583+
cd distill
537584
go build -o distill .
585+
go test ./...
538586
```
539587

540588
## License
@@ -546,6 +594,8 @@ For commercial licensing, contact: siddhantkhare2694@gmail.com
546594
## Links
547595

548596
- [Website](https://distill.siddhantkhare.com)
549-
- [LinkedIn](https://www.linkedin.com/in/siddhantkhare24)
597+
- [Playground](https://distill.siddhantkhare.com/playground)
598+
- [Blog Post](https://dev.to/siddhantkcode/the-engineering-guide-to-context-window-efficiency-202b)
550599
- [MCP Configuration](mcp/README.md)
600+
- [Book a Demo](https://meet.siddhantkhare.com)
551601

0 commit comments

Comments
 (0)