Skip to content

self-development: cover all agent runtimes in per-runtime docs#1229

Closed
kelos-bot[bot] wants to merge 1 commit into
mainfrom
kelos-config-update-20260528-1800
Closed

self-development: cover all agent runtimes in per-runtime docs#1229
kelos-bot[bot] wants to merge 1 commit into
mainfrom
kelos-config-update-20260528-1800

Conversation

@kelos-bot
Copy link
Copy Markdown

@kelos-bot kelos-bot Bot commented May 28, 2026

🤖 Kelos Agent @gjkim42

What type of PR is this?

/kind cleanup

What this PR does / why we need it:

Adds one new convention to AGENTS.md (with CLAUDE.md as its symlink) and the inline agentsMD copies in self-development/agentconfig.yaml and self-development/kelos-workers.yaml:

Cover every supported agent runtime in docs that describe per-runtime behavior. Kelos supports five agent runtimes (claude-code, gemini, codex, opencode, cursor) and they differ on instruction-file paths, env var names, and CLI flags accepted by the entrypoint. When a doc/README/example describes such per-runtime behavior — e.g., where spec.agentsMD is written, which file the agent reads on startup, which API-key variable the entrypoint honors — enumerate the behavior per runtime (one row per claude-code/gemini/codex/opencode/cursor) or explicitly say "Example uses Claude Code; see docs/agent-image-interface.md for the path your agent uses." Writing only the Claude Code path (e.g., ~/.claude/CLAUDE.md) silently misleads readers running the other four runtimes — they will look for a file the entrypoint never creates. This is the docs analogue of "Parameterize e2e tests across all supported agent types."

Motivating review feedback

PR #1209 (docs: clarify per-agent destination paths for agentsMD, merged 2026-05-24, fixes #1208). The merged change rewrote the spec.agentsMD docs in README.md and docs/reference.md to enumerate each agent's destination instead of describing only ~/.claude/CLAUDE.md. Per the PR description:

The README and docs/reference.md previously described spec.agentsMD as being written to ~/.claude/CLAUDE.md, which is only the destination used by the Claude Code entrypoint. Each agent entrypoint writes KELOS_AGENTS_MD to a different agent-specific path:

Agent Path
claude-code ~/.claude/CLAUDE.md
gemini ~/.gemini/GEMINI.md
codex ~/.codex/AGENTS.md
opencode ~/.config/opencode/AGENTS.md
cursor ~/.cursor/AGENTS.md

A Gemini or Codex user reading the previous docs would expect their agentsMD content to land in ~/.claude/CLAUDE.md, which doesn't exist for their agent.

That is the exact failure mode this convention is meant to prevent on future docs PRs.

A related but distinct rule — Parameterize e2e tests across all supported agent types — is already proposed in open config-update PR #1162 (motivated by PR #1175 "this should not be a codex specific e2e test"). This PR adds the docs-side analogue: where the e2e rule says "test every runtime," the new rule says "document every runtime." Same underlying mistake (agent assumes Claude Code = all agents), different surface.

Scope notes

Which issue(s) this PR is related to:

N/A

Special notes for your reviewer:

N/A

Does this PR introduce a user-facing change?

NONE

Summary by cubic

Add a docs rule to cover all supported agent runtimes whenever behavior differs by runtime. Updates AGENTS.md (and CLAUDE.md symlink) plus inline copies in self-development/agentconfig.yaml and self-development/kelos-workers.yaml to require enumerating paths/env/flags for claude-code, gemini, codex, opencode, and cursor (avoids misleading single-runtime paths like ~/.claude/CLAUDE.md).

Written for commit f630aa9. Summary will update on new commits.

Review in cubic

Codify the lesson from #1208 / #1209: README and `docs/reference.md` had
described `spec.agentsMD` as being written to `~/.claude/CLAUDE.md` —
the path used only by the Claude Code entrypoint. Gemini writes
`~/.gemini/GEMINI.md`, Codex writes `~/.codex/AGENTS.md`, Opencode
writes `~/.config/opencode/AGENTS.md`, and Cursor writes
`~/.cursor/AGENTS.md`. The single-runtime doc silently misled users on
the other four runtimes, who would look for a file the entrypoint never
created.

Add a new bullet to AGENTS.md (with CLAUDE.md as its symlink) and the
inline `agentsMD` copies in `self-development/agentconfig.yaml` and
`self-development/kelos-workers.yaml`. The new rule is the docs analogue
of the existing "Parameterize e2e tests across all supported agent
types" convention.
@github-actions github-actions Bot added needs-triage kind/cleanup needs-kind Indicates an issue or PR lacks a kind/* label needs-priority needs-actor release-note-none and removed needs-kind Indicates an issue or PR lacks a kind/* label labels May 28, 2026
@gjkim42 gjkim42 closed this May 29, 2026
@gjkim42 gjkim42 deleted the kelos-config-update-20260528-1800 branch May 29, 2026 12:00
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.

Docs: AgentConfig.agentsMD path documented as ~/.claude/CLAUDE.md but varies by agent type

1 participant