docs: concept guides and complete API reference#98
Merged
Conversation
- 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
0982b79 to
02909c3
Compare
This was referenced Mar 21, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
sidebars.ts: add Concepts category and expand API Reference section to 9 itemsFiles added
docs/concepts/rag.md— RAG pipeline concept guide with ASCII diagram, chunking, HNSW, hybrid searchdocs/concepts/agents.md— ReAct loop, function calling, multi-agent patternsdocs/concepts/graphs.md— StateGraph DAG model, reducers, HITL, checkpointingdocs/concepts/embeddings.md— cosine similarity, HNSW, MMR, model selection guidedocs/api/rag-pipeline.md— RAGConfig + RAGPipeline full parameter tables and examplesdocs/api/state-graph.md— StateGraph, CompiledGraph, TypedState, StateField, checkpointersdocs/api/agents.md— AgentConfig, ReActAgent, FunctionCallingAgent, AgentExecutor, BaseTool, @tool, HandoffChain, Crew, MCPAgentdocs/api/memory.md— All 9 memory backends with constructor tables and selection guidedocs/api/evaluation.md— EvaluationPipeline, 5 metrics, @eval_case, EvalCaseMeta, CLI usagedocs/api/observability.md— TokenTracer, CostTracker, BudgetGuard, OTelExporter, TracingMiddleware, DistributedTracerFiles 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 tablesidebars.ts— Added Concepts category; API Reference expanded from 3 to 9 itemsTest plan
npm run buildpasses with no errors