docs: rewrite README for open-source launch#33
Conversation
Overhaul the README to reflect the current state of the project and make it compelling for open-source discovery: - Update tool count from "40+" to "55+" (actual current count) - Remove reference to query cost prediction (feature was removed) - Add comparison table: general coding agents vs altimate-code - Add quick demo section with practical workflow examples - Add agent modes table (Builder, Analyst, Validator, Migrator, Executive) - Add /discover command to quick start flow - Feature 11 data engineering skills under dbt Native section - Add accuracy stats (100% on 1,077 queries, 100% edge match on 500) - Add banner image, docs badge, and doc page links - Add community section (Issues, Discussions, Security) - Update tagline to "The data engineering agent for dbt, SQL, and cloud warehouses" Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
jontsai
left a comment
There was a problem hiding this comment.
LGTM
Much more compelling README for OSS discovery. Verified:
✓ No references to removed cost prediction feature (cleaned up from #31)
✓ Tool count updated to 55+
✓ Comparison table is effective marketing
✓ Benchmark claims present (100% accuracy on 1,077 queries, 100% edge match on 500) — make sure these are defensible
✓ /discover command properly featured
✓ Executive agent mode added to the table (not in docs homepage PR #32 — might want to sync)
✓ Banner image path references existing asset from #32
✓ Dev setup condensed but still clear, CONTRIBUTING.md link preserved
nit: The dev setup one-liner combines TS and Python steps — might trip up contributors who only want one side. But fine for a README.
Ship it! 🚢
Overhaul the README to reflect the current state of the project and make it compelling for open-source discovery: - Update tool count from "40+" to "55+" (actual current count) - Remove reference to query cost prediction (feature was removed) - Add comparison table: general coding agents vs altimate-code - Add quick demo section with practical workflow examples - Add agent modes table (Builder, Analyst, Validator, Migrator, Executive) - Add /discover command to quick start flow - Feature 11 data engineering skills under dbt Native section - Add accuracy stats (100% on 1,077 queries, 100% edge match on 500) - Add banner image, docs badge, and doc page links - Add community section (Issues, Discussions, Security) - Update tagline to "The data engineering agent for dbt, SQL, and cloud warehouses" Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
Summary
/discovercommand, accuracy benchmarks, community links, and banner imageKey changes
/discoverTest plan
docs/docs/assets/images/altimate-code-banner.png)🤖 Generated with Claude Code