Skip to content

docs: add reference pages and cookbooks#96

Merged
AmitoVrito merged 1 commit into
mainfrom
docs/reference-and-cookbooks
Mar 21, 2026
Merged

docs: add reference pages and cookbooks#96
AmitoVrito merged 1 commit into
mainfrom
docs/reference-and-cookbooks

Conversation

@AmitoVrito
Copy link
Copy Markdown
Contributor

Summary

Pages added

Reference

  • docs/reference/env-vars.md — complete table of all env vars, secrets manager examples, validation helpers
  • docs/reference/errors.md — every exception with causes, examples, and fixes
  • docs/reference/troubleshooting.md — 12 symptoms with diagnosis steps and fixes
  • docs/reference/security.md — API key management, PII detection, content filtering, OWASP AI Top 10
  • docs/reference/production.md — Dockerfile, docker-compose, GitHub Actions, Kubernetes HPA, OTel tracing

Cookbook

  • docs/cookbook/intro.md — cookbook index
  • docs/cookbook/rag-patterns.md — 20 patterns from basic to GraphRAG, HyDE, Self-RAG, RAG Fusion, eval, cost tracking, multimodal
  • docs/cookbook/agent-patterns.md — 15 patterns from minimal to multi-agent supervisor/crew, MCP, MockLLM testing, eval cases
  • docs/cookbook/graph-patterns.md — 15 patterns covering linear, conditional routing, parallel fan-out, human-in-the-loop, SSE/WebSocket streaming, TypedState, Mermaid export

Test plan

  • npm run build passes with no errors
  • Verify all sidebar links navigate correctly in dev server
  • Review code examples for accuracy

Closes #83 #84 #85 #86 #87 #88 #89 #90

Add 5 reference pages (env vars, errors, troubleshooting, security, production)
and 3 cookbook files (RAG patterns, agent patterns, graph patterns) with a
cookbook index page, and update sidebars.ts to include the new sections.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Environment variables and configuration reference

1 participant