Skip to content

docs(readme): tighter tagline; drop misleading 500-commit corpus number#196

Merged
RaghavChamadiya merged 2 commits into
mainfrom
docs/readme-dev-and-team-framing
May 14, 2026
Merged

docs(readme): tighter tagline; drop misleading 500-commit corpus number#196
RaghavChamadiya merged 2 commits into
mainfrom
docs/readme-dev-and-team-framing

Conversation

@RaghavChamadiya
Copy link
Copy Markdown
Member

Summary

  • New tagline. The codebase intelligence layer for your AI coding agent. The previous tagline tried to enumerate the audience (solo devs / engineering teams) and was too long.
  • Drop the '500 commits' corpus claims. Several spots in the README said repowise mines '500 commits of history' / 'last 500 commits' / '500-commit git history'. That implied a global cap on the corpus, but co_change_commit_limit is actually a per-file limit, not a repo-wide cap. Replaced with neutral phrasing ('git history', 'per-file, configurable depth') so the README doesn't undersell larger histories or contradict the actual default in config.yaml.
  • Soften engineering-team-only framing. A handful of phrases ('per-engineer profile pages', 'engineering-leader rollup', 'when a senior engineer leaves') read as team-only when most of these signals (hotspots, ownership concentration, contributor profile, bus factor, decisions) are equally useful on a solo repo. Reworded to 'author' / per-module rollup and reframed the decisions-intelligence line so it speaks to both audiences without spelling it out in every paragraph.

Test plan

  • Render the README on GitHub and confirm the new tagline reads well under the logo.
  • Grep for '500 commits' in README.md — should only remain inside the git: co_change_commit_limit: 500 config block (which is the real default).
  • Skim the Git Intelligence and Git intelligence sections — confirm wording reads as inclusive without the explicit 'solo vs team' callouts.

…ng 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.
- 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.
@RaghavChamadiya RaghavChamadiya requested a review from swati510 as a code owner May 14, 2026 17:17
@RaghavChamadiya RaghavChamadiya merged commit 22551f0 into main May 14, 2026
5 checks passed
@RaghavChamadiya RaghavChamadiya deleted the docs/readme-dev-and-team-framing branch May 14, 2026 17:21
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.

2 participants