docs: correct claims the code does not back - #78
Open
r0h1tb wants to merge 4 commits into
Open
Conversation
Audited README, AGENTS.md and docs/ against the current source. - The CLI list was missing nine commands and gave `update` and `sandbox` signatures that do not parse. - `docs/python-api.md` documented `get_diff(from_commit=, to_commit=, file_path=)`; `repo_path` is required and there is no per-file filter, so the documented call raises TypeError. - The example config used `"bge-m3"` and an unexplained `remote_url`. The default is `BAAI/bge-m3` and embeddings are local; `remote_url` additionally requires `dimension`, which EmbeddingManager raises about. - Nothing said the `ast-rag-mcp` and `ast-rag-watch` entry points need the `[mcp]` extra. - The Phase-2 quality table read as current. Dated it, and said what the benchmarks measure and how to re-run them. - `summarize` shipped but was still listed as planned; Go was still listed under "More Languages" after landing.
… source extract_nodes returns the same 31 nodes for ast_rag_api.py with and without source, so the note was wrong.
… weights There is no ast_rag/embeddings.py. The knobs are embedding.vector_weight / keyword_weight, exposed as --vector-weight / --keyword-weight on query.
r0h1tb
force-pushed
the
docs/truth-audit
branch
from
August 24, 2026 21:28
7691d38 to
36b6a63
Compare
Owner
|
docs/STACK_TRACE_MAPPING.md - it's not a big deal that it's in English. If it's a nuisance, you can translate it into English. typo in agents.md, it's best to fix it. |
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.
Description
Audited README,
AGENTS.md,CONTRIBUTING.mdanddocs/against the currentsource. Every change below was checked by running the thing it describes.
Commands and flags that don't exist as documented
create-database,call-graph,symbol-impact,blocks,lambdas,summarize,analyze-stacktrace,cache-statsandstatswere undocumented.ast-rag update <path>→Missing option '--from-commit'. Both--from-commitand--to-commitare required.ast-rag sandbox <lang> <cmd>→FileNotFoundError: workdir does not exist.The second positional is
workdir; the command goes in--cmd.--from/--toand a--current-branchthat doesn't exist.query --verboseandsig --kind→No such option.callersto "find what it calls"; that'scall-graph --direction callees.AGENTS.mddescribedworkspaceas "Update from git diff"; it showsuncommitted changes.
Python API examples that raise
get_diff(from_commit=, to_commit=, file_path=)— real signature isget_diff(repo_path, from_commit, to_commit=None, limit, offset), noper-file filter.
full_index(driver, path, commit=)— real isfull_index(driver, nodes, edges, commit_hash=...) -> None.update_from_git(root=, from_commit=, to_commit=)— real kwargs arerepo_path,old_commit,new_commit.index_directory,ast_rag.graph_schema,ast_rag.embeddingsandast_rag.benchmarks.evaluatordo not exist.find_referencesreturns a dict of dicts, not objects with.node.ASTNode.node_typeiskind.ProjectConfig.model_validate_json("ast_rag_config.json")takes JSON text,not a path.
Config
NEO4J_URI/QDRANT_URL/EMBEDDING_URLare read nowhere. The realset is the six
AST_RAG_*vars incli.py:132-137; there is noembedding-URL override.
remote_urlwith nodimension, which raisesEmbeddingConfig.dimension must be set when using remote_url. Embeddings arelocal by default and
docker-compose.ymlstarts no embedding server.model_namedefault isBAAI/bge-m3, notbge-m3.embeddings.py" — no such module. The real knobs arevector_weight/keyword_weight.[mcp]extra, without whichast-rag-mcpandast-rag-watchare onPATHbut fail to import.Shell scripts that never existed
./scripts/index-remaining.shandindex-sequential.share referenced acrossfour docs.
git log --all -- 'scripts/*.sh'is empty andscripts/containsonly
README.md.Graph schema
Both ID formulas were wrong — the node ID includes
project_idand the edge IDincludes
dep_kind:raw_type_string:confidence. Verified by computing bothhashes. Added the missing
Blocklabel andTYPES/DEPENDS_ON/CROSS_FILE_CALLedges, and noted thatHAS_PARAMETER,VIRTUAL_CALLandLAMBDA_CALLare declared and indexed but never emitted.Roadmap drift
summarizeshipped but was listed as planned; Go was still under "Morelanguages" in README and CONTRIBUTING after landing in #17.
Related Issue
None — a sweep. #66 was already fixed and closed; only its roadmap half remained.
Type of Change
Checklist
ast-rag evaluate --all— needs live servicesTesting
No source changes. Commands and flags checked against
ast-rag <cmd> --help,API signatures and imports against the source, config fields against
dto/config.pyand theEmbeddingManagerguard, ID formulas by computing thehashes both ways.
Not re-measured: the Phase-2 numbers themselves need live Neo4j and Qdrant.
git log -S "F1 Score" -- README.mddates them to1852590, 2026-02-26, sothey are dated and marked as not re-measured rather than restated as current.
Also left alone with reasons: QUICKSTART's indexing-time estimates, the
roadmap rows with no evidence either way, and the SUMMARIZATION model
recommendations.
Three things left for you
scripts/README.mddocuments both nonexistent shell scripts in detail, andREADME links it as "Indexing utilities". Needs deleting or rewriting — out of
scope here.
docs/STACK_TRACE_MAPPING.mdis in Russian whileAGENTS.mdsaysdocumentation is English. A policy call, not a false claim; only its imports
were fixed.
AGENTS.mdline 8 has a paste artifact:.qweAlways confirm documentation language preference.... Left as-is.