self-development: cover all agent runtimes in per-runtime docs#1229
Closed
kelos-bot[bot] wants to merge 1 commit into
Closed
self-development: cover all agent runtimes in per-runtime docs#1229kelos-bot[bot] wants to merge 1 commit into
kelos-bot[bot] wants to merge 1 commit into
Conversation
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
🤖 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(withCLAUDE.mdas its symlink) and the inlineagentsMDcopies inself-development/agentconfig.yamlandself-development/kelos-workers.yaml:Motivating review feedback
PR #1209 (
docs: clarify per-agent destination paths for agentsMD, merged 2026-05-24, fixes #1208). The merged change rewrote thespec.agentsMDdocs inREADME.mdanddocs/reference.mdto enumerate each agent's destination instead of describing only~/.claude/CLAUDE.md. Per the PR description: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
CLAUDE.mdis a symlink toAGENTS.md, so a single edit covers both surfaces.agentsMDinself-development/agentconfig.yamlandself-development/kelos-workers.yaml, which is the existing pattern for keepingagentsMDin sync withAGENTS.md.self-development/*.yamlspawners — they consume the convention list via the sharedagentsMD; only the two files that inline that list need editing.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?
Summary by cubic
Add a docs rule to cover all supported agent runtimes whenever behavior differs by runtime. Updates
AGENTS.md(andCLAUDE.mdsymlink) plus inline copies inself-development/agentconfig.yamlandself-development/kelos-workers.yamlto require enumerating paths/env/flags forclaude-code,gemini,codex,opencode, andcursor(avoids misleading single-runtime paths like~/.claude/CLAUDE.md).Written for commit f630aa9. Summary will update on new commits.
Review in cubic