Audit remediation: 4 code fixes + doc corrections#23
Merged
LeahArmstrong merged 11 commits intomainfrom Mar 4, 2026
Merged
Conversation
added 11 commits
February 28, 2026 17:39
Apps using `schema_format: :sql` have `db/structure.sql` instead of `db/schema.rb`. Try schema.rb first, fall back to structure.sql.
Skip ViewComponent descendants that have no resolvable file_path and empty source_code — these are framework internals (e.g., Lookbook base classes) that produce noise in extraction output.
Add engine_source metadata (:framework or :application) based on whether the engine root lives outside Rails.root (gem path) or under it.
Include generated_at timestamp and graph_sha (digest of dependency_graph.json) so consumers can verify whether the analysis is in sync with the current graph.
Remove desc from self_analyze and retrieve tasks so they don't appear in the public task listing. They remain callable but are developer-only debugging tools.
- Fix tool counts: Index Server 28, Console Server 33 - Fix tier counts: 8/10/12/3 - Fix unit_type -> type in Getting Started guide - Remove non-existent snapshot_metadata.rb from tree - Add missing migrations (004, 005) to tree - Add missing subsystems to tree: cache/, cost_model/, notion/, mcp/renderers/, flow_precomputer.rb, filename_utils.rb - Add Docker usage examples - Document codebase-index-mcp-start wrapper in Claude Code setup - Add install generator + initializer to Installation section - Document embed, embed_incremental, flow, console, notion_sync tasks - Add Notion integration link - Add CI caching step to incremental example - Add Rails boot requirement note to Ruby API section
Update tool counts (28/33), add missing subsystems (cache/, cost_model/, filename_utils.rb), add mcp-start executable.
Extract stub_rails_root_and_logger helper to reduce complexity of stub_rails_respond_to.
…, correct tool counts Engine framework_engine? now checks for /vendor/ and /bundler/gems/ in the path instead of only comparing against Rails.root — fixes all 17 engines being tagged as "application" when vendor/bundle is under Rails.root in Docker. View component filter simplified to skip any component with no resolvable file_path, instead of requiring both nil file_path and empty source_code. Catches framework-internal components (Lookbook etc.) regardless of source_code state. Tool counts corrected to match actual source: Index Server 27 (not 28), Console Server 31 (not 33), tier breakdown 9/9/10/3. Added notion_sync to MCP_SERVERS.md tool catalog.
New docs/DOCKER_SETUP.md covers the split architecture (Index Server on host, extraction in container), volume mount requirements, path translation, both Console Server modes, and troubleshooting. Updated README, GETTING_STARTED, MCP_SERVERS, docs index, and CLAUDE.md with Docker callouts and cross-references.
Create 10 new user-question-oriented docs to improve Context7 benchmark score: FAQ, Troubleshooting, Why CodebaseIndex, Architecture, Extractor Reference, MCP Tool Cookbook, and 3 Context7 skills. Add context7.json to control indexing scope and eliminate ~1.2MB of noise from internal docs. Streamline README from 620 to 325 lines — add Quick Start section and Documentation table, replace verbose extractor/subsystem sections with summaries linking to dedicated docs. Fix MCP tool counts across CLAUDE.md (28→27 index, 33→31 console) to match actual source. Fix TROUBLESHOOTING.md incorrectly claiming config.extractors controls which extractors run (it controls retrieval scope; all 34 extractors always run).
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
1 participant
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
Addresses 4 functionality gaps and 10+ documentation inaccuracies found during a host-app audit.
Code fixes:
schema_shanow supportsdb/structure.sql(for apps usingschema_format: :sql):frameworkor:applicationbased on root pathgraph_analysis.jsonincludesgenerated_atandgraph_shafor staleness detectionRake cleanup:
self_analyzeandretrievetasks hidden fromrails -T(internal debugging tools)Documentation:
unit_type→typein Getting Started guidesnapshot_metadata.rbfrom treecodebase-index-mcp-startdocs, install generator section, expanded task list, CI caching step, Notion link, Ruby API boot noteTest plan