From a8c83289963cf3f72b848b1d1b948fdc98a18abe Mon Sep 17 00:00:00 2001 From: wonder Date: Tue, 5 May 2026 11:10:57 +0800 Subject: [PATCH] docs: add ref_docs usage guidelines and directory overview to CLAUDE.md --- CLAUDE.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/CLAUDE.md b/CLAUDE.md index 229a03e..25d9962 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -55,6 +55,24 @@ Use a SubAgent for commit generation when the change is non-trivial, to keep the ## Restrictions - **Do NOT use WebSearch.** All work must rely on local code, existing documentation, and tool-provided context only. +- **Consult `ref_docs/` first** when working with Eino framework APIs, patterns, or best practices. + +## Reference Documentation + +Eino framework reference docs are stored in `ref_docs/`. Before writing Eino-related code, read the relevant doc(s) to ensure correct API usage and patterns. + +| Topic | Path | +|---|---| +| Chain & Graph Orchestration | `ref_docs/core_modules/chain_and_graph_orchestration/` | +| Components (ChatModel, Retriever, Embedding, Lambda, Indexer, Tools, etc.) | `ref_docs/core_modules/components/` | +| Eino ADK (Agent: quickstart, interface, extension, collaboration, HITL, middleware) | `ref_docs/core_modules/eino_adk/` | +| Flow Integration (React Agent, Multi-Agent Hosting) | `ref_docs/core_modules/flow_integration_components/` | +| DevOps (IDE Plugin, Visual Debug, Visual Orchestration) | `ref_docs/core_modules/devops/` | + +Usage rules: +- Read the relevant `_index.md` or guide file before implementing any Eino feature. +- Follow the patterns and interfaces described in the docs exactly; do not improvise API usage. +- When unsure which doc to consult, read `ref_docs/core_modules/_index.md` for an overview. ## Architecture