docs: rewrite README for open-source launch
Merged
AN
7mo ago+102+102+012345678901234567890123456789-85-85-01234567890123456789
Summary
- Rewrites the README to reflect the current state of the project and make it compelling for open-source discovery
- Updates stale numbers (40+ ā 55+ tools), removes reference to deleted query cost prediction feature
- Adds comparison table (general agents vs altimate-code), quick demo section, agent modes,
/discovercommand, accuracy benchmarks, community links, and banner image
Key changes
| What | Before | After |
|---|---|---|
| Tool count | "40+" | "55+" |
| Cost prediction | Listed as feature | Removed (was deleted in #31) |
| Agent modes | Not mentioned | Builder, Analyst, Validator, Migrator, Executive |
| Skills | Not mentioned | 11 data engineering skills |
/discover | Not mentioned | Featured in quick start |
| Comparison table | Not present | Added (vs general agents) |
| Demo examples | None | 5 practical examples |
| Community section | Not present | Issues, Discussions, Security links |
| Banner image | Not present | Added |
| Docs badge | Not present | Added |
Test plan
- Verify banner image renders on GitHub (
docs/docs/assets/images/altimate-code-banner.png) - Verify all badge URLs resolve (npm, PyPI, License, CI, Docs)
- Verify doc links work (getting-started, sql-tools, agent-modes, model-providers)
- Confirm no references to removed features (query cost prediction)
- Cross-check feature claims against docs site
š¤ Generated with Claude Code