Skip to content

Commit 22551f0

Browse files
docs(readme): tighter tagline; drop misleading 500-commit corpus number (#196)
* docs(readme): drop misleading 500-commit corpus number; broaden framing to solo devs The '500 commits' references implied repowise mines only the last 500 commits of the repo. That isn't accurate — co_change_commit_limit is per-file, not a global corpus cap. Replace the specific numbers with 'git history' / 'configurable depth' so the README doesn't undersell larger histories or contradict the actual default. Also rebalance the framing: the intro and git-intelligence sections read as engineering-team-only, but most of these signals (hotspots, ownership concentration, contributor profile, bus factor, decisions) are equally useful for solo devs returning to their own code months later. Call that out directly so individual users see themselves in the README. * docs(readme): tighter tagline; drop misleading 500-commit corpus number - New tagline: 'The codebase intelligence layer for your AI coding agent.' The previous one tried to enumerate the audience and was too long. - The '500 commits' references implied repowise mines only the last 500 commits of the repo. That isn't accurate — co_change_commit_limit is per-file, not a global corpus cap. Replace with 'git history' / 'configurable depth' so the README doesn't undersell larger histories or contradict the actual default. - Soften 'engineer' / 'engineering-leader' framing to 'author' / per-module rollup so the language doesn't read as team-only when most of these signals are equally useful on a solo repo. Kept the change subtle — no per-bullet 'solo vs team' callouts.
1 parent c6f4ef0 commit 22551f0

1 file changed

Lines changed: 13 additions & 13 deletions

File tree

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<div align="center">
22

33
<img src=".github/assets/logo.png" width="280" alt="repowise" /><br />
4-
**Codebase intelligence for AI-assisted engineering teams.**
4+
**The codebase intelligence layer for your AI coding agent.**
55

66
Four intelligence layers. Seven MCP tools. Multi-repo workspaces. Auto-sync hooks. One `pip install`.
77

@@ -21,7 +21,7 @@ Four intelligence layers. Seven MCP tools. Multi-repo workspaces. Auto-sync hook
2121

2222
</div>
2323

24-
Your AI coding agent reads files. It does not know who owns them, which ones change together, which ones are dead, or why they were built the way they were. It has the source code and zero institutional knowledge.
24+
Your AI coding agent reads files. It doesn't know which ones change together, which ones are dead, or why they were built the way they were. It has the source code and no memory of how the codebase got there.
2525

2626
repowise fixes that. It indexes your codebase into four intelligence layers — dependency graph, git history, auto-generated documentation, and architectural decisions — and exposes them to Claude Code (and any MCP-compatible AI agent) through seven precisely designed tools. Multi-repo? Initialize a workspace and get cross-repo co-change detection, API contract extraction, and federated MCP queries across all your services. **27× fewer tokens per query. 36% cheaper. Same answer quality.**
2727

@@ -68,7 +68,7 @@ repowise runs once, builds everything, then keeps it in sync on every commit.
6868
tree-sitter parses every file across 14 languages into a two-tier dependency graph — file nodes and symbol nodes (functions, classes, methods). A 3-tier call resolver with confidence scoring handles import aliases, barrel re-exports, and namespace imports. Heritage extraction covers extends, implements, trait impls, derive macros, mixins, and extension conformance. Leiden community detection finds logical modules even when your directory structure doesn't reflect them. PageRank, betweenness centrality, SCC analysis, and execution flow tracing from entry points identify your most central, most coupled, and most traversed code.
6969

7070
### ◈ Git Intelligence
71-
500 commits of history turned into signals: hotspot files (high churn × high complexity), ownership percentages per engineer, co-change pairs (files that change together without an import link — hidden coupling), and significant commit messages that explain *why* code evolved. Rolled up into engineering-leader views — **contributor profiles** (per-engineer module rollups, top files, co-authors, silo modules, dead-code burden), **module health scorecards** (composite score over churn × ownership × docs × dead code × bus factor), and **reviewer suggestions** for any PR file list, weighted by direct authorship, co-change history, and recency.
71+
Your git history turned into signals: hotspot files (high churn × high complexity), ownership percentages per author, co-change pairs (files that change together without an import link — hidden coupling), and significant commit messages that explain *why* code evolved. Rolled up into **contributor profiles** (per-author module rollups, top files, co-authors, silo modules, dead-code burden), **module health scorecards** (composite score over churn × ownership × docs × dead code × bus factor), and **reviewer suggestions** for any PR file list, weighted by direct authorship, co-change history, and recency.
7272

7373
### ◈ Documentation Intelligence
7474
An LLM-generated wiki for every module and file, rebuilt incrementally on every commit. Coverage tracking. Freshness scoring per page. Semantic search via RAG. Confidence scores show how current each page is relative to the underlying code.
@@ -129,7 +129,7 @@ To manually add the MCP server to another editor:
129129
}
130130
```
131131

132-
> **Note on init time:** Initial indexing analyzes your entire codebase — AST parsing, 500-commit git history, LLM doc generation, embedding indexing, and decision archaeology. This is a one-time cost (~25 minutes for a 3,000-file project). Every subsequent update after a commit takes under 30 seconds and only regenerates the few pages affected by your changes.
132+
> **Note on init time:** Initial indexing analyzes your entire codebase — AST parsing, git-history mining, LLM doc generation, embedding indexing, and decision archaeology. This is a one-time cost (~25 minutes for a 3,000-file project). Every subsequent update after a commit takes under 30 seconds and only regenerates the few pages affected by your changes.
133133
134134
> **Full docs:** [Quickstart](docs/QUICKSTART.md) · [User Guide](docs/USER_GUIDE.md) · [CLI Reference](docs/CLI_REFERENCE.md) · [MCP Tools](docs/MCP_TOOLS.md) · [Workspaces](docs/WORKSPACES.md) · [Computed Glossary](docs/COMPUTED_GLOSSARY.md) · [Auto-Sync](docs/AUTO_SYNC.md)
135135
@@ -259,8 +259,8 @@ This is what happens when an AI agent has real codebase intelligence.
259259
| **Symbols** | Searchable index of every function, class, and method, server-ranked by importance (PageRank × visibility × complexity × kind × entry-point). Filter facets for public-only, language, kind, in-hotspot-files, and in-entry-point-files. Click any symbol for graph metrics, callers/callees, class heritage, and a git panel with governing decisions |
260260
| **Coverage** | Doc freshness per file with one-click regeneration |
261261
| **Risk** | One page, six tabs: Hotspots (with inline drill-down to the top importance-ranked symbols in each file), Heatmap (ownership treemap with bus-factor borders and silo overlay), Module Health, Dead Code, Impact (blast radius), and the always-visible risk strip linking to each |
262-
| **Contributors** | Paginated contributor directory and per-engineer profile pages — modules they own, top files, co-authors, commit category mix, silo modules, bus-factor risk files, and dead-code burden. Click any owner anywhere in the dashboard to drill in |
263-
| **Module Health** | Engineering-leader rollup per top-level module: composite health score (churn / ownership / docs / dead code / bus factor) with sortable list and a per-module detail page showing owners, top hotspots, and governing decisions |
262+
| **Contributors** | Paginated contributor directory and per-author profile pages — modules they own, top files, co-authors, commit category mix, silo modules, bus-factor risk files, and dead-code burden. Click any owner anywhere in the dashboard to drill in |
263+
| **Module Health** | Per-module rollup with a composite health score (churn / ownership / docs / dead code / bus factor), sortable list, and a per-module detail page showing owners, top hotspots, and governing decisions |
264264
| **Hotspots** | Ranked by trend-weighted score (180-day decay) and churn. Paginated load-more; each row expands inline to the most important symbols in that file |
265265
| **Dead Code** | Unused code with confidence scores, owner leaderboard, and bulk actions |
266266
| **Decisions** | Architectural decisions with staleness monitoring. Decision detail has a writable module-linkage editor so a decision's governance scope can be edited and shows up on the linked module's health page |
@@ -371,29 +371,29 @@ Monorepo with 4 packages. Entry points: api/server.ts, cli/index.ts.
371371
- CircuitBreaker on all external calls — after payment provider outages in Q3 2024
372372

373373
## Hidden coupling (no import link, but change together)
374-
- auth.ts ↔ middleware/session.ts — co-changed 31 times in last 500 commits
374+
- auth.ts ↔ middleware/session.ts — co-changed 31 times
375375
<!-- REPOWISE:END -->
376376
```
377377

378378
---
379379

380380
## Git intelligence
381381

382-
repowise mines your last 500 commits (configurable) to produce signals no static analysis can find.
382+
repowise mines your git history (per-file, configurable depth) to produce signals no static analysis can find.
383383

384384
**Hotspots** — files in the top 25% of both churn and complexity. These are where bugs live. Flagged in the dashboard, in CLAUDE.md, and surfaced by `get_risk()` before Claude Code touches them.
385385

386-
**Ownership**`git blame` aggregated into ownership percentages per engineer. Know who to ping. Know where knowledge silos exist.
386+
**Ownership**`git blame` aggregated into ownership percentages per author. Know who to ping. Know where knowledge silos exist.
387387

388388
**Co-change pairs** — files that change together in the same commit without an import link. Hidden coupling that AST parsing cannot detect. `get_context()` surfaces co-change partners alongside direct dependencies.
389389

390-
**Bus factor** — files owned >80% by a single engineer. Shown in the ownership view. Surfaced in CLAUDE.md as knowledge risk.
390+
**Bus factor** — files owned >80% by a single author. Shown in the ownership view. Surfaced in CLAUDE.md as knowledge risk.
391391

392392
**Significant commits** — the last 10 meaningful commit messages per file (filtered: no merges, no dependency bumps, no lint) are included in generation prompts. The LLM explains *why* code is structured the way it is.
393393

394-
**Contributor profiles** — every engineer with commits gets a profile page: modules they own, top files, co-authors, commit category mix (feat / fix / refactor / docs / test / chore / perf), silo modules they're solely on, bus-factor risk files, and dead-code burden. Surfaced via `/repos/<id>/owners` in the dashboard and linked from every owner reference.
394+
**Contributor profiles** — every author with commits gets a profile page: modules they own, top files, co-authors, commit category mix (feat / fix / refactor / docs / test / chore / perf), silo modules they're solely on, bus-factor risk files, and dead-code burden. Surfaced via `/repos/<id>/owners` in the dashboard and linked from every owner reference.
395395

396-
**Module health** — composite 0–100 score per top-level module derived from silo penalty, hotspot density, dead-code percentage, average churn, doc coverage, and median bus factor. Surfaced on the Risk page and the new per-module detail page, with cross-links to owners, hotspots, and governing decisions.
396+
**Module health** — composite 0–100 score per top-level module derived from silo penalty, hotspot density, dead-code percentage, average churn, doc coverage, and median bus factor. Surfaced on the Risk page and the per-module detail page, with cross-links to owners, hotspots, and governing decisions.
397397

398398
**Reviewer suggestions** — paste a PR file list into Blast Radius and get a ranked list of likely reviewers, scored by direct authorship (×1.0), co-change partners (×0.5), and recency (×0.4), capped at the 5 strongest co-change signals per file.
399399

@@ -443,7 +443,7 @@ repowise decision health
443443

444444
Decisions are linked to graph nodes, tracked for staleness as code evolves, and surfaced by `get_why()` whenever Claude Code touches governed files.
445445

446-
When a senior engineer leaves, the "why" usually leaves with them. Decision intelligence keeps it in the codebase.
446+
The "why" usually walks out the door — when a teammate leaves, or when you reopen your own repo six months later. Decision intelligence keeps it in the codebase.
447447

448448
---
449449

0 commit comments

Comments
 (0)