docs: condense README to elevator pitch (#478)#688
docs: condense README to elevator pitch (#478)#688planetf1 merged 12 commits intogenerative-computing:mainfrom
Conversation
|
The PR description has been updated. Please fill out the template for your PR to be reviewed. |
Merge ProtectionsYour pull request matches the following merge protections and will not be merged until they are valid. 🟢 Enforce conventional commitWonderful, this rule succeeded.Make sure that we follow https://www.conventionalcommits.org/en/v1.0.0/
|
|
@psschwei thanks for review - see comments above |
psschwei
left a comment
There was a problem hiding this comment.
sorry, this one didn't get submitted
ajbozarth
left a comment
There was a problem hiding this comment.
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.
Co-authored-by: Paul Schweigert <paul@paulschweigert.com>
Co-authored-by: Paul Schweigert <paul@paulschweigert.com>
- Remove mellea.ai row from Learn More table (keep only docs.mellea.ai) - Link 'source installation' to CONTRIBUTING.md on install line
|
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. |
|
@psschwei @ajbozarth all comments addressed and branch rebased onto upstream/main — could you take another look when you get a chance? |
psschwei
left a comment
There was a problem hiding this comment.
LGTM
I also did a quick compare with what we have on mellea.ai and its largely consistent
17f1f57
Misc PR
Type of PR
Description
Fixes README v2 - Condensed elevator pitch (~60 lines vs current 210) #478
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:
mellea.ai(website) anddocs.mellea.ai(docs)@generative+ Pydantic code example replacing two examples and the Colab tableCONTRIBUTING.md, building-extensions docs, and mellea-contribsTesting