Skip to content

docs: concept guides and complete API reference#98

Merged
AmitoVrito merged 1 commit into
mainfrom
docs/concepts-and-api
Mar 21, 2026
Merged

docs: concept guides and complete API reference#98
AmitoVrito merged 1 commit into
mainfrom
docs/concepts-and-api

Conversation

@AmitoVrito
Copy link
Copy Markdown
Contributor

Summary

Files added

  • docs/concepts/rag.md — RAG pipeline concept guide with ASCII diagram, chunking, HNSW, hybrid search
  • docs/concepts/agents.md — ReAct loop, function calling, multi-agent patterns
  • docs/concepts/graphs.md — StateGraph DAG model, reducers, HITL, checkpointing
  • docs/concepts/embeddings.md — cosine similarity, HNSW, MMR, model selection guide
  • docs/api/rag-pipeline.md — RAGConfig + RAGPipeline full parameter tables and examples
  • docs/api/state-graph.md — StateGraph, CompiledGraph, TypedState, StateField, checkpointers
  • docs/api/agents.md — AgentConfig, ReActAgent, FunctionCallingAgent, AgentExecutor, BaseTool, @tool, HandoffChain, Crew, MCPAgent
  • docs/api/memory.md — All 9 memory backends with constructor tables and selection guide
  • docs/api/evaluation.md — EvaluationPipeline, 5 metrics, @eval_case, EvalCaseMeta, CLI usage
  • docs/api/observability.md — TokenTracer, CostTracker, BudgetGuard, OTelExporter, TracingMiddleware, DistributedTracer

Files modified

  • docs/api/retriever.md — Expanded from 1 to 16 retriever strategies (Retriever, HybridSearch, MMR, ContextualCompression, SelfQuery, ParentDocument, MultiQuery, Ensemble, BM25, TimeWeighted, Metadata, LongContextReorder, StepBack, GraphRAG, HyDE, Caching) with selection guide table
  • sidebars.ts — Added Concepts category; API Reference expanded from 3 to 9 items

Test plan

  • npm run build passes with no errors

- Add concepts/rag.md, concepts/agents.md, concepts/graphs.md, concepts/embeddings.md (#65-#68)
- Add api/rag-pipeline.md, api/state-graph.md, api/agents.md, api/memory.md (#69-#72)
- Expand api/retriever.md with 16 retriever strategies and selection guide (#73)
- Add api/evaluation.md and api/observability.md (#74)
- Update sidebars.ts: add Concepts section and expand API Reference to 9 items
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

1 participant