Skip to content

docs(readme): reposition around building and running agents#5390

Merged
mmabrouk merged 9 commits into
release/v0.105.6from
docs-readme-agent-positioning
Jul 19, 2026
Merged

docs(readme): reposition around building and running agents#5390
mmabrouk merged 9 commits into
release/v0.105.6from
docs-readme-agent-positioning

Conversation

@mmabrouk

Copy link
Copy Markdown
Member

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):

Agenta is an open-source LLMOps platform... prompt management, evaluation, and observability.

After:

Agenta is an open-source workspace for building and running agents... build an agent by chatting with it, share it with a team, run it in the background.

Two files change: the top-level README.md and sdks/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

  • Three inline documentation links point at the docs home as placeholders for now: the "support matrix" link, the "complete roadmap" link, and the roadmap "(documentation)" labels. They will be repointed once the real deep-link pages exist.
  • No code or behavior changes. Documentation only.

https://claude.ai/code/session_01DnitLJdk54jARsPSEQdAjH

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
@vercel

vercel Bot commented Jul 18, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
agenta-documentation Ready Ready Preview, Comment Jul 19, 2026 12:57pm

Request Review

@coderabbitai

coderabbitai Bot commented Jul 18, 2026

Copy link
Copy Markdown

Review Change Stack

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: d8daa983-3c27-42c6-9d18-1c7d39d2a3cc

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
📝 Walkthrough

Walkthrough

Both 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.

Changes

README refresh

Layer / File(s) Summary
Agent workspace positioning and content
README.md, sdks/python/README.md
Hero messaging and major documentation sections are rewritten to cover Agenta’s agent workspace positioning, features, setup options, roadmap, comparisons, and community content.
README assets and telemetry guidance
sdks/python/README.md, README.md
Python SDK community badges are updated, and anonymized telemetry disabling instructions are removed from both README files.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Possibly related PRs

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title accurately summarizes the README repositioning around building and running agents.
Description check ✅ Passed The description matches the documented README rewrites and telemetry section removal.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs-readme-agent-positioning

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

mmabrouk added 3 commits July 19, 2026 13:52
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.
@mmabrouk
mmabrouk marked this pull request as ready for review July 19, 2026 12:15
@dosubot dosubot Bot added size:L This PR changes 100-499 lines, ignoring generated files. documentation Improvements or additions to documentation labels Jul 19, 2026
@mmabrouk
mmabrouk changed the base branch from main to release/v0.105.6 July 19, 2026 12:15

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 4


ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: bd3534c6-d68e-4251-b967-c134bf2db38a

📥 Commits

Reviewing files that changed from the base of the PR and between 3b0c0cb and 57af217.

📒 Files selected for processing (2)
  • README.md
  • sdks/python/README.md

Comment thread README.md Outdated
Comment thread sdks/python/README.md Outdated
Comment thread sdks/python/README.md Outdated
Comment thread sdks/python/README.md
@github-actions

github-actions Bot commented Jul 19, 2026

Copy link
Copy Markdown
Contributor

Railway Preview Environment

Preview URL https://gateway-production-d070.up.railway.app/w
Project agenta-oss-pr-5390
Image tag pr-5390-e4cb391
Status Deployed
Railway logs Open logs
Workflow logs View workflow run
Updated at 2026-07-19T13:05:54.664Z

…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
mmabrouk added 2 commits July 19, 2026 14:54
Removed outdated video link and some badge images from the README.
Updated contributor count and added new contributors to the README.
@mmabrouk
mmabrouk merged commit 55064a1 into release/v0.105.6 Jul 19, 2026
8 of 9 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 size:L This PR changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant