Skip to content

docs: rewrite README for open-source launch#33

Merged
anandgupta42 merged 1 commit intomainfrom
docs/rewrite-readme-oss-launch
Mar 4, 2026
Merged

docs: rewrite README for open-source launch#33
anandgupta42 merged 1 commit intomainfrom
docs/rewrite-readme-oss-launch

Conversation

@anandgupta42
Copy link
Copy Markdown
Contributor

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, /discover command, 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

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>
Copy link
Copy Markdown

@jontsai jontsai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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! 🚢

@anandgupta42 anandgupta42 merged commit 4f4844f into main Mar 4, 2026
4 checks passed
@kulvirgit kulvirgit deleted the docs/rewrite-readme-oss-launch branch March 10, 2026 21:06
anandgupta42 added a commit that referenced this pull request Mar 17, 2026
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>
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