docs(readme): reposition around building and running agents#5390
Conversation
Rewrite the top-level and Python SDK READMEs from the old LLMOps positioning to the new agent-workspace positioning: build agents by chatting with them, share them with a team, and run them in the background. Preserve all existing chrome (logo, badges, contributors table, star and cloud CTAs). Remove the stale telemetry section whose documented opt-out flag no longer does anything. Claude-Session: https://claude.ai/code/session_01DnitLJdk54jARsPSEQdAjH
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
📝 WalkthroughWalkthroughBoth README files are repositioned around Agenta as an open-source workspace for building and running agents. Their marketing, setup, roadmap, comparison, and community sections are rewritten, Python SDK badges are refreshed, and telemetry-disabling instructions are removed. ChangesREADME refresh
Estimated code review effort: 1 (Trivial) | ~5 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Updated README with improved clarity and formatting, including enhancements to feature descriptions and roadmap items.
Updated the README to include new sections for getting started with Agenta Cloud and self-hosting instructions. Removed outdated roadmap content.
Railway Preview Environment
|
…EADME Address CodeRabbit review on #5390: add alt text to the social badges, tag the self-host instruction block as text, drop the duplicate OpenAI roadmap entry, and fix OpenRouter/OAuth casing. Clean up typos from the web edits: garbled issue-link text, tab-indented list items, and the misplaced harness link in the subscription section. Mirror the reworked copy from sdks/python/README.md into the root README, keeping the walkthrough video and the root contributors table. Claude-Session: https://claude.ai/code/session_016e3DXYsLcyA7JGfQj9H2v9
Removed outdated video link and some badge images from the README.
Updated contributor count and added new contributors to the README.
Context
The top-level README and the Python SDK README both opened by calling Agenta an "LLMOps platform" and led with prompt management, evaluation, and observability. That framing no longer matches what people come to Agenta to do. They build agents, work on them with a team, and run them. The old copy buried that story under infrastructure language.
Changes
Both READMEs are rewritten around the new positioning: an open-source workspace for building and running agents. The narrative is now build an agent by chatting with it, share it with your team, and run it in the background.
Before (top of each README):
After:
Two files change: the top-level
README.mdandsdks/python/README.md. All existing design chrome is preserved: the logo, the badges, the contributors table, and the star and cloud call-to-action buttons.The stale telemetry section is removed. It documented an opt-out flag that no longer does anything, so leaving the instructions in place would tell readers to set a flag with no effect.
Notes
https://claude.ai/code/session_01DnitLJdk54jARsPSEQdAjH