From 886df61051040e1d84930d577eec31d5401c0ffb Mon Sep 17 00:00:00 2001 From: Ed_ Date: Wed, 10 Jun 2026 20:32:11 -0400 Subject: [PATCH] docs(rag): correct the 'Removed fields' note (claim ChunkingConfig was wrong) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The previous note in guide_rag.md §RAGConfig Schema said: 'ast_chunking_enabled lives in ChunkingConfig (not in RAGConfig)' This was a documentation lie. Verified by grep: - 'class ChunkingConfig' returns 0 matches in src/ - 'ast_chunking_enabled' returns 0 matches anywhere in src/ - The 5 fields (ast_chunking_enabled, auto_index_on_load, auto_sync_interval_seconds, vector_store_backend, vector_store_path) were never in the real RAGConfig. They were fictional. Rewrite the note to be honest: 'the old doc was fictional; the real RAGConfig has 5 fields; the other 5 fields never existed'. Clarify that top_k is a real runtime parameter (on RAGEngine.search()) not a config field. --- docs/guide_rag.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guide_rag.md b/docs/guide_rag.md index 87e245c5..f88e14ba 100644 --- a/docs/guide_rag.md +++ b/docs/guide_rag.md @@ -319,7 +319,7 @@ class RAGConfig: chunk_overlap: int = 200 ``` -> **Removed fields** (moved to other systems or not yet implemented): `ast_chunking_enabled` lives in `ChunkingConfig` (not in `RAGConfig`); `vector_store_backend`/`vector_store_path` replaced by nested `VectorStoreConfig`; `auto_index_on_load`/`auto_sync_interval_seconds`/`top_k` are runtime parameters set by the controller, not persisted in `RAGConfig`. +> **What about the fields the old doc showed?** The 2026-06-10 docs sync verified against `src/models.py:1029-1040` that the previous `RAGConfig` schema was **fictional** — most of the fields it listed never existed in the real dataclass. Specifically: `ast_chunking_enabled` does not exist anywhere in `src/` (there is no `ChunkingConfig` class — I claimed one existed in an earlier draft of this note and was wrong; flagging the correction here); `vector_store_backend` and `vector_store_path` never existed on `RAGConfig` (they were a flattened version of the now-nested `VectorStoreConfig`); `auto_index_on_load` and `auto_sync_interval_seconds` do not exist anywhere in `src/` (they were aspirational; the actual index-on-load and auto-sync behavior is wired in `RAGEngine` and the controller's `mma_state_update` flow, not via persisted config); `top_k` IS a real thing but it is a **runtime parameter** to `RAGEngine.search(query, top_k=5)` and `RAGEngine._search_mcp(query, top_k=5)` (`src/rag_engine.py:339, 322`), not a field on `RAGConfig` — the old doc confused "config field" with "search parameter." ### Behavior When Disabled