Skip to content

docs: update OpenChoreo description to match what's on the website#35

Open
sameerajayasoma wants to merge 1 commit into
openchoreo:mainfrom
sameerajayasoma:main
Open

docs: update OpenChoreo description to match what's on the website#35
sameerajayasoma wants to merge 1 commit into
openchoreo:mainfrom
sameerajayasoma:main

Conversation

@sameerajayasoma

@sameerajayasoma sameerajayasoma commented Jun 18, 2026

Copy link
Copy Markdown
Member

We recently updated the OpenChoreo description to say that we support running agentic workloads.

OpenChoreo is a developer platform for Kubernetes that lets developers and AI agents build, deploy, and operate apps, resources, and agentic workloads. It provides development and platform abstractions, a Backstage-powered developer portal, CI/CD, GitOps, and observability.

Summary by CodeRabbit

  • Documentation
    • Updated platform description to clarify support for developers and AI agents in building, deploying, and operating apps, resources, and agentic workloads.

Signed-off-by: Sameera Jayasoma <sameera.madushan@gmail.com>
@coderabbitai

coderabbitai Bot commented Jun 18, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

A single sentence in profile/README.md is reworded to broaden OpenChoreo's stated value proposition, adding explicit mention of AI agents, agentic workloads, and the expanded "build, deploy, and operate" framing in place of the prior shorter abstractions-focused phrasing.

Changes

README Intro Update

Layer / File(s) Summary
README intro sentence reword
profile/README.md
Line 11 replaces the shorter "offering development and architecture abstractions…" description with expanded wording that explicitly includes AI agents, agentic workloads, and a "build, deploy, and operate" framing.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

A hop, a tweak, a word or two,
The README blooms with something new!
Agentic workloads join the fray,
Deploy and operate, hooray! 🐇
One line rewritten, sharp and bright —
The bunny stamps it: looks just right. ✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description lacks most required sections from the template including Purpose, Goals, Approach, User stories, Release note, and other mandatory fields. Complete the pull request description using the repository template, including Purpose, Goals, Approach, Release note, Documentation, and other required sections relevant to this documentation update.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change—updating OpenChoreo's description to match the website version—and is clear and specific.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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 and usage tips.

@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: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@profile/README.md`:
- Line 11: The closing HTML tag on line 11 uses uppercase `</P>` when it should
be lowercase `</p>` to match the opening tag `<p>` and follow standard HTML
conventions. Change the closing paragraph tag from `</P>` to `</p>` to ensure
consistent markup formatting and proper HTML standards compliance.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 6d03c54f-ef3e-47bf-820c-30806b000afc

📥 Commits

Reviewing files that changed from the base of the PR and between 8e13187 and 99660c7.

📒 Files selected for processing (1)
  • profile/README.md

Comment thread profile/README.md
A complete, open-source developer platform for Kubernetes
</h1>
<p>OpenChoreo is a developer platform for Kubernetes offering development and architecture abstractions, a Backstage-powered developer portal, application CI/CD, GitOps, and observability.</P>
<p>OpenChoreo is a developer platform for Kubernetes that lets developers and AI agents build, deploy, and operate apps, resources, and agentic workloads. It provides development and platform abstractions, a Backstage-powered developer portal, CI/CD, GitOps, and observability.</P>

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Normalize HTML closing tag to lowercase.

The closing tag </P> should be lowercase </p> to match the opening tag and follow HTML conventions for consistency.

✏️ Proposed fix
-  <p>OpenChoreo is a developer platform for Kubernetes that lets developers and AI agents build, deploy, and operate apps, resources, and agentic workloads. It provides development and platform abstractions, a Backstage-powered developer portal, CI/CD, GitOps, and observability.</P>
+  <p>OpenChoreo is a developer platform for Kubernetes that lets developers and AI agents build, deploy, and operate apps, resources, and agentic workloads. It provides development and platform abstractions, a Backstage-powered developer portal, CI/CD, GitOps, and observability.</p>
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
<p>OpenChoreo is a developer platform for Kubernetes that lets developers and AI agents build, deploy, and operate apps, resources, and agentic workloads. It provides development and platform abstractions, a Backstage-powered developer portal, CI/CD, GitOps, and observability.</P>
<p>OpenChoreo is a developer platform for Kubernetes that lets developers and AI agents build, deploy, and operate apps, resources, and agentic workloads. It provides development and platform abstractions, a Backstage-powered developer portal, CI/CD, GitOps, and observability.</p>
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@profile/README.md` at line 11, The closing HTML tag on line 11 uses uppercase
`</P>` when it should be lowercase `</p>` to match the opening tag `<p>` and
follow standard HTML conventions. Change the closing paragraph tag from `</P>`
to `</p>` to ensure consistent markup formatting and proper HTML standards
compliance.

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