Skip to content

docs: condense README to elevator pitch (#478)#688

Merged
planetf1 merged 12 commits intogenerative-computing:mainfrom
planetf1:examplereadme
Mar 26, 2026
Merged

docs: condense README to elevator pitch (#478)#688
planetf1 merged 12 commits intogenerative-computing:mainfrom
planetf1:examplereadme

Conversation

@planetf1
Copy link
Contributor

@planetf1 planetf1 commented Mar 18, 2026

Misc PR

Type of PR

  • Bug Fix
  • New Feature
  • Documentation
  • Other

Description

Condenses the root README from 206 lines to ~80 lines, replacing detailed installation notes, example walkthroughs, and a verbose contributing section with a focused elevator pitch and links out to the docs site for deeper reading.

Key changes:

  • Opening paragraph names the "generative programs" paradigm and frames the problem/solution, aligned with the mellea.ai landing page vision
  • Adds explicit badges and links for both mellea.ai (website) and docs.mellea.ai (docs)
  • Single accurate @generative + Pydantic code example replacing two examples and the Colab table
  • Contributing section links directly to CONTRIBUTING.md, building-extensions docs, and mellea-contribs
  • Fixes pre-existing GitHub License badge link (was pointing to badge image URL, not the LICENSE file)
  • Adds Apache-2.0 license footer

Testing

  • Tests added to the respective file if code was changed
  • New code has 100% coverage if code as added
  • Ensure existing tests and github automation passes (a maintainer will kick off the github automation when the rest of the PR is populated)

@github-actions
Copy link
Contributor

The PR description has been updated. Please fill out the template for your PR to be reviewed.

@mergify
Copy link

mergify bot commented Mar 18, 2026

Merge Protections

Your pull request matches the following merge protections and will not be merged until they are valid.

🟢 Enforce conventional commit

Wonderful, this rule succeeded.

Make sure that we follow https://www.conventionalcommits.org/en/v1.0.0/

  • title ~= ^(fix|feat|docs|style|refactor|perf|test|build|ci|chore|revert|release)(?:\(.+\))?:

@planetf1 planetf1 requested a review from psschwei March 18, 2026 11:29
@planetf1 planetf1 marked this pull request as ready for review March 18, 2026 11:36
@planetf1 planetf1 requested a review from a team as a code owner March 18, 2026 11:36
Copy link
Member

@psschwei psschwei left a comment

Choose a reason for hiding this comment

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

minor nits, otherwise LGTM

@planetf1
Copy link
Contributor Author

@psschwei thanks for review - see comments above

Copy link
Member

@psschwei psschwei left a comment

Choose a reason for hiding this comment

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

sorry, this one didn't get submitted

Copy link
Contributor

@ajbozarth ajbozarth left a comment

Choose a reason for hiding this comment

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

Overall looks good, just want to double check that all the removed content is located in other places (CONTRIBUTING or docs) or was just out of date.

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Mar 26, 2026
@planetf1
Copy link
Contributor Author

Yes — all removed content was checked. Detailed install instructions, the Colab notebooks, and code examples are all reachable via the Learn More table links. The verbose contributing section is covered by the three bullet links. The old feature list was the only thing not re-homed, but it described internals in a way that no longer matched the current API so it was intentionally dropped.

@planetf1
Copy link
Contributor Author

@psschwei @ajbozarth all comments addressed and branch rebased onto upstream/main — could you take another look when you get a chance?

Copy link
Member

@psschwei psschwei left a comment

Choose a reason for hiding this comment

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

LGTM

I also did a quick compare with what we have on mellea.ai and its largely consistent

@planetf1 planetf1 added this pull request to the merge queue Mar 26, 2026
Merged via the queue into generative-computing:main with commit 17f1f57 Mar 26, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

README v2 - Condensed elevator pitch (~60 lines vs current 210)

3 participants