Repository navigation
Document autotune, MCP server and 0.12.1 cache behavior - #5
Merged
Merged
Conversation
Docs lagged behind the engine through 0.13.0. Fill the gaps found by an audit against the code: - cli.md: full synopsis (tune, mcp, treesitter on index, query --auto/--pool, eval --auto), index hyperparameter flags and precedence, new `tune` section, default `all` includes treesitter, hybrid arm reuse - customize-indexing.md: new "Tune hyperparameters" section with the --auto decision rules - architecture.md: three access paths (CLI, engine API, MCP), one cache slot per strategy, current engine/plugin layout - index.md, install.md, troubleshooting.md: MCP server, seven skills, mcp extra, MCP troubleshooting table - persistence-and-cache.md: freshness fast path (meta + 4 KB head probe), recorded hyperparams/corpus_stats - engine-api.md: complete generated API page list - index-and-query.md: correct knowledge-skill count Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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
The docs were behind the engine as of 0.13.0. I checked each page against the code (
cli.pyargparse,autotune.py,persistence.py,mcp_server.py,pyproject.tomlextras) and filled these gaps:docs/never mentionedretrieval tune,index --autoor the 10 hyperparameter flags.cli.mdnow documents them, including that an explicit flag beats--auto, which beats the static default.customize-indexing.mdgets a new "Tune hyperparameters" section that lists each decision rule.tuneandmcp.indexwas missingtreesitter,querywas missing--auto/--pool, andevalwas missing--auto.indexbuilds 4 strategies; the code builds 5.integrate-coding-agents.md. It is now also inindex.md, which now lists all seven skills includingdomain-context-retrieval. It is also ininstall.md(themcpextra and auto-registration),troubleshooting.md(a new MCP table) andarchitecture.md.persistence-and-cache.mdnow covers the freshness fast path: it readsmetaplus a 4 KB head probe of the data file. It also covers thehyperparams/corpus_statsstored in meta, andhybridreusing the lexical/turbovec arms built earlier in the same run.Docs only; no code changes.
Test plan
mkdocs build --strictpasses with no warningstunecan write transcript sidecars.--target-charsdoesn't apply to prose files.--ast-max-charsonly applies to treesitter.🤖 Generated with Claude Code