Skip to content

docs: Update README (WIP)#3995

Draft
andygrove wants to merge 7 commits intoapache:mainfrom
andygrove:docs/refresh-readme
Draft

docs: Update README (WIP)#3995
andygrove wants to merge 7 commits intoapache:mainfrom
andygrove:docs/refresh-readme

Conversation

@andygrove
Copy link
Copy Markdown
Member

@andygrove andygrove commented Apr 18, 2026

Which issue does this PR close?

N/A

Rationale for this change

The README hasn't been updated in a very long time.

Rendered version: https://github.com/andygrove/datafusion-comet/blob/docs/refresh-readme/README.md

What changes are included in this PR?

  • Focus on benefits
  • Highlight the 50% cost savings message
  • Add feature list
  • Add "Getting Started" section, linking to user docs
  • Remove single node SF100 benchmark results. They are still available in the benchmarking guide.

How are these changes tested?

- Add supported Spark versions section linking to compatibility matrix
- Add 'What Comet Accelerates' features list (Parquet, Iceberg, shuffle,
  expressions, aggregations, joins, windows, metrics)
- Fix heading hierarchy (Benefits demoted to h2 with h3 subsections)
- Expand Getting Started with a concrete Spark config snippet
- Split community links into their own section
- Drop stale hard-coded speedup number; remove self-referential
  Acknowledgments section
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.

1 participant