Skip to content

docs: refresh README architecture + PARSERS table after v0.4 changes#14

Merged
joy-software merged 1 commit into
developfrom
docs/post-restructure-update
May 31, 2026
Merged

docs: refresh README architecture + PARSERS table after v0.4 changes#14
joy-software merged 1 commit into
developfrom
docs/post-restructure-update

Conversation

@joy-software
Copy link
Copy Markdown
Contributor

Summary

Post-restructure doc audit (via an Explore agent) flagged three stale items:

File What was wrong
README.md `Architecture (v0.3)` diagram Listed pre-restructure top-level paths for federation, watcher, fts, call_log, context_builder, etc.
README.md MCP tool count "23 tools" — actual @mcp.tool count is 39
docs/PARSERS.md Existing Parsers table missing Go, Rust, Java (added in #11)

All three updated. CLAUDE.md was also stale but it's locally git-ignored on this checkout, so it stays out of the PR — I edited my local copy.

Verification

  • `uvx ruff check .` clean
  • 235 / 235 tests still pass
  • CI green on this PR

Three doc updates from the post-restructure / new-features audit:

README.md
- "Architecture (v0.3)" diagram replaced with the v0.4 layout: the
  3 top-level files plus all 9 subpackages (core, parsers, imports,
  state, analysis, claude_state, server, cli, integrations, viz,
  skills). Each entry annotated with what's inside.
- "codegraph exposes 23 tools" -> 39 tools (the actual @mcp.tool
  count across server/tools_*.py).

docs/PARSERS.md
- Existing Parsers table now lists Go (golang.py), Rust (rust.py),
  Java (java.py), and plaintext.py.
- Optional Dependencies section rewritten as "Dependencies" — every
  supported tree-sitter grammar is now a core dep in pyproject.toml
  (was the case before this audit, just hadn't been documented).

Not touched
- CLAUDE.md was edited locally for the same shape but it's in
  .git/info/exclude on this checkout, so it stays out of the PR.
- docs/CLI_REFERENCE.md and docs/CONFIGURATION.md — audit found
  them generic enough to survive the restructure unchanged.
@joy-software joy-software merged commit fbcd9e6 into develop May 31, 2026
1 check passed
@joy-software joy-software deleted the docs/post-restructure-update branch May 31, 2026 15:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant