Skip to content

docs: Refocus README on agent+environment and workflow integration#1052

Merged
gjkim42 merged 1 commit into
mainfrom
update-readme
Apr 29, 2026
Merged

docs: Refocus README on agent+environment and workflow integration#1052
gjkim42 merged 1 commit into
mainfrom
update-readme

Conversation

@gjkim42
Copy link
Copy Markdown
Collaborator

@gjkim42 gjkim42 commented Apr 29, 2026

What type of PR is this?

/kind docs

What this PR does / why we need it:

Refocuses the README around Kelos's two core concerns:

  1. Defining the agent and the environment it runs in as one unit — prompt, model, instructions, plugins, MCP servers, git workspace, credentials, and Pod resources all live together as Kubernetes resources.
  2. Defining how agents integrate with your workflows — triggering runs from GitHub issues, PRs, webhooks, Linear, Jira, schedules, or any HTTP source, and chaining agents into pipelines.

Concrete changes:

  • Rewrite the intro paragraphs to lead with the two concerns above.
  • Regroup the four Core Primitives under those two concerns (Task/Workspace/AgentConfig vs. TaskSpawner) and switch the list to bullets so the grouping reads cleanly.
  • Drop the standalone "Kelos Developing Kelos" section and its top-nav link; keep a single supporting mention under Orchestration Patterns and repoint the link to self-development/README.md.
  • Fix the top-nav "Integration" link to point at the in-page #integration anchor instead of docs/integration.md.
  • Tighten the Workspace bullet to "(URL, ref, auth)" — the previous draft mentioned an "optional persistent volume" that the Workspace API does not actually expose.

The original "Orchestrate autonomous AI coding agents on Kubernetes." tagline is preserved.

Which issue(s) this PR is related to:

N/A

Special notes for your reviewer:

Docs-only change; no code, tests, or CI surface touched. The deleted ## Kelos Developing Kelos H2 may have inbound links from external write-ups — low impact, flagging in case it matters.

Does this PR introduce a user-facing change?

NONE

Summary by cubic

Refocuses the README on defining the agent+environment as one unit and on how agents fit into workflows. Clarifies core concepts, restores the self-development case study, and cleans up nav links.

  • Refactors
    • Rewrites intro around two concerns: agent+environment and workflow integration.
    • Regroups Core Primitives under those concerns with concise bullets.
    • Moves self-development write-up into “Case Study: Kelos Developing Kelos” after Orchestration Patterns; removes the top-nav link and links to it from the pattern bullet.
    • Fixes the “Integration” link to use the in-page #integration anchor.
    • Narrows the Workspace definition to “URL, ref, auth” and removes the inaccurate persistent volume note.

Written for commit b7954c0. Summary will update on new commits. Review in cubic

Copy link
Copy Markdown

@cubic-dev-ai cubic-dev-ai Bot left a comment

Choose a reason for hiding this comment

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

No issues found across 1 file

…egration

Reframe the intro and Core Primitives around Kelos's two concerns:
defining the agent together with its runtime environment, and defining
how agents integrate with workflows. Move the self-development write-up
out of the intro into a "Case Study: Kelos Developing Kelos" section
after Orchestration Patterns so it stays visible without dominating the
top of the page.
@gjkim42 gjkim42 enabled auto-merge April 29, 2026 13:59
@gjkim42 gjkim42 added this pull request to the merge queue Apr 29, 2026
Merged via the queue into main with commit b38892a Apr 29, 2026
19 checks passed
@gjkim42 gjkim42 deleted the update-readme branch April 29, 2026 14:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant