docs: optimize README — minimal quick start, agent guides in docs/#268
Merged
thepagent merged 1 commit intoopenabdev:mainfrom Apr 13, 2026
Merged
Conversation
…o docs/ - README now shows only Kiro CLI (default) quick start - Each agent (Claude Code, Codex, Gemini) gets its own docs/<agent>.md - Multi-agent Helm setup moved to docs/multi-agent.md - Simplified Pod Architecture diagram - Collapsed reactions config into <details> tag - Added agent table with links to individual guides
thepagent
approved these changes
Apr 13, 2026
Reese-max
pushed a commit
to Reese-max/openab
that referenced
this pull request
Apr 14, 2026
…o docs/ (openabdev#268) - README now shows only Kiro CLI (default) quick start - Each agent (Claude Code, Codex, Gemini) gets its own docs/<agent>.md - Multi-agent Helm setup moved to docs/multi-agent.md - Simplified Pod Architecture diagram - Collapsed reactions config into <details> tag - Added agent table with links to individual guides Co-authored-by: 超渡法師 <chaodu-agent@openab.dev>
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
2 participants
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.
What
README was getting cluttered as more CLI agents were added. This PR restructures documentation to keep the README minimal.
Changes
README.md (280 → 198 lines):
<details>tagNew docs/:
docs/kiro.md— Kiro CLI install, config, authdocs/claude-code.md— Claude Code install, config, authdocs/codex.md— Codex install, config, authdocs/gemini.md— Gemini CLI install, config, authdocs/multi-agent.md— Multi-agent Helm setup (advanced)Why
As we add more agents (Copilot, OpenCode, etc.), the README should stay clean. New users see the default (Kiro) quick start immediately. Advanced users follow links to the specific agent they need.
No code changes — docs only.