headroom/mkdocs.yml
chopratejas c61ba522a3 Fix docs to match implementation: remove false claims, add Strands guide
- Remove CrewAI and OpenAI Agents SDK claims (not implemented)
- Upgrade LangChain from "Experimental" to "Stable" (fully implemented)
- Fix latency FAQ: "1-5ms" → accurate "15-200ms" with cost-benefit context
- Create docs/strands.md (README linked to it but file didn't exist)
- Align docs/index.md with compress() function API (was showing stale class API)
- Add Strands, MCP, Integration Guide to mkdocs nav
- Note stale v0.3.7 benchmarks in LATENCY_BENCHMARKS.md

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-03-25 20:04:35 -07:00

97 lines
2.3 KiB
YAML

site_name: Headroom
site_description: The Context Optimization Layer for LLM Applications
site_url: https://chopratejas.github.io/headroom
repo_url: https://github.com/chopratejas/headroom
repo_name: chopratejas/headroom
edit_uri: edit/main/docs/
theme:
name: material
palette:
- scheme: default
primary: indigo
accent: indigo
toggle:
icon: material/brightness-7
name: Switch to dark mode
- scheme: slate
primary: indigo
accent: indigo
toggle:
icon: material/brightness-4
name: Switch to light mode
features:
- content.code.copy
- content.tabs.link
- navigation.instant
- navigation.tabs
- navigation.sections
- navigation.top
- search.highlight
- search.suggest
- toc.follow
icon:
repo: fontawesome/brands/github
plugins:
- search
markdown_extensions:
- admonition
- attr_list
- def_list
- md_in_html
- tables
- toc:
permalink: true
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- pymdownx.details
nav:
- Home: index.md
- Getting Started:
- Quickstart: quickstart.md
- Installation: getting-started.md
- Benchmarks: benchmarks.md
- User Guide:
- Proxy Server: proxy.md
- Compression: compression.md
- Image Compression: image-compression.md
- CCR (Compress-Cache-Retrieve): ccr.md
- Configuration: configuration.md
- Integrations:
- Integration Guide: integration-guide.md
- LangChain: langchain.md
- Agno: agno.md
- Strands: strands.md
- MCP Tools: mcp.md
- Advanced:
- LLMLingua: llmlingua.md
- Text Compression: text-compression.md
- Transforms: transforms.md
- Architecture: ARCHITECTURE.md
- Reference:
- API: api.md
- SDK: sdk.md
- Metrics: metrics.md
- Errors: errors.md
- Troubleshooting: troubleshooting.md
- Deployment:
- macOS: macos-deployment.md
- Memory:
- Overview: memory.md
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/chopratejas/headroom
- icon: fontawesome/brands/python
link: https://pypi.org/project/headroom-ai/