-
-
Notifications
You must be signed in to change notification settings - Fork 14
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Description
Summary
Comprehensive documentation for all v2.0 features.
Motivation
New features need clear documentation for adoption. Good docs reduce support burden and improve developer experience.
Sections to Add/Update
- Compression Guide - How semantic compression works, configuration options
- Summarization Guide - Hierarchical summarization, importance scoring
- Cache Configuration - Memory vs Redis, TTL settings, sizing
- Pipeline Usage - End-to-end examples, best practices
- Migration from v1 - Breaking changes, upgrade path
- Performance Tuning - Benchmarks, optimization tips
- API Reference - OpenAPI spec for new endpoints
Documentation Structure
docs/
├── getting-started.md
├── guides/
│ ├── compression.md
│ ├── summarization.md
│ ├── caching.md
│ └── pipeline.md
├── reference/
│ ├── api.md
│ ├── cli.md
│ └── configuration.md
├── migration/
│ └── v1-to-v2.md
└── examples/
├── langchain.md
├── llamaindex.md
└── mcp.md
Acceptance Criteria
- All new features documented
- Code examples for each feature
- Migration guide complete
- README updated with v2 highlights
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation