From 8cc3c320997eb60840b60f2a8c0692d4b3953715 Mon Sep 17 00:00:00 2001 From: YeonGyu-Kim Date: Thu, 14 May 2026 12:59:01 +0900 Subject: [PATCH] docs: refresh user-facing docs to match v4.1.1 codebase Align README.md, CONTRIBUTING.md, and docs/ with the same ground truth used in the hierarchical AGENTS.md regeneration commit 1e7a7600a: - README.md: '25+ built-in hooks' was undercounted by ~30 hooks; now reads '54+ lifecycle hooks (61 with Team Mode)' to match actual tier composition. - CONTRIBUTING.md: src/hooks/ '52 hooks across 55 modules' -> '54 base (61 team) across 58 dirs'; src/tools/ '26 tools across 16 directories' -> '20-39 tools (config-gated)'; src/features/ '19 feature modules' -> '20 feature modules' (boulder-state, team-mode added). - docs/reference/features.md: Core-agent order indices were off-by-one; Sisyphus 1/Hephaestus 2/Prometheus 3/Atlas 4 -> 0/1/2/3 (matches installAgentSortShim). - docs/guide/overview.md: Sisyphus model recommendations now mention Kimi K2.6 alongside K2.5 since K2.6 is the active default fallback in the primary Sisyphus chain (see src/shared/model-requirements.ts). --- CONTRIBUTING.md | 6 +++--- README.md | 2 +- docs/guide/overview.md | 8 ++++---- docs/reference/features.md | 2 +- 4 files changed, 9 insertions(+), 9 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f1ded421d..e641bce7b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -112,10 +112,10 @@ oh-my-opencode/ │ ├── index.ts # Plugin entry (V1 PluginModule, default export) │ ├── plugin-config.ts # JSONC multi-level config (Zod v4) │ ├── agents/ # 11 agents (Sisyphus, Hephaestus, Oracle, Librarian, Explore, Atlas, Prometheus, Metis, Momus, Multimodal-Looker, Sisyphus-Junior) -│ ├── hooks/ # 52 lifecycle hooks across 55 dedicated modules -│ ├── tools/ # 26 tools across 16 directories +│ ├── hooks/ # 54 base lifecycle hooks (61 with Team Mode) across 58 dirs +│ ├── tools/ # 20-39 tools across 16 directories (config-gated) │ ├── mcp/ # 3 built-in remote MCPs (websearch, context7, grep_app) -│ ├── features/ # 19 feature modules (background-agent, skill-loader, tmux, MCP-OAuth, etc.) +│ ├── features/ # 20 feature modules (background-agent, skill-loader, tmux, MCP-OAuth, boulder-state, etc.) │ ├── config/ # Zod v4 schema system │ ├── shared/ # Cross-cutting utilities │ ├── cli/ # CLI: install, run, doctor, mcp-oauth (Commander.js) diff --git a/README.md b/README.md index a90dbdc7e..ce960344d 100644 --- a/README.md +++ b/README.md @@ -368,7 +368,7 @@ See [Configuration Documentation](docs/reference/configuration.md). - **Sisyphus Agent**: Main orchestrator with Prometheus (Planner) and Metis (Plan Consultant) - **Background Tasks**: Configure concurrency limits per provider/model - **Categories**: Domain-specific task delegation (`visual`, `business-logic`, custom) -- **Hooks**: 25+ built-in hooks, all configurable via `disabled_hooks` +- **Hooks**: 54+ lifecycle hooks (61 with Team Mode), all configurable via `disabled_hooks` - **MCPs**: Built-in websearch (Exa), context7 (docs), grep_app (GitHub search) - **LSP**: Full LSP support with refactoring tools - **Experimental**: Aggressive truncation, auto-resume, and more diff --git a/docs/guide/overview.md b/docs/guide/overview.md index 7c38b0fdd..c704ea3cf 100644 --- a/docs/guide/overview.md +++ b/docs/guide/overview.md @@ -83,10 +83,10 @@ Sisyphus is your main orchestrator. He plans, delegates to specialists, and driv **Recommended models:** - **Claude Opus 4.7** — Best overall experience. Sisyphus was built with Claude-optimized prompts. -- **Kimi K2.5** — Great Claude-like alternative. Many users run this combo exclusively. +- **Kimi K2.6** / **K2.5** — Great Claude-like alternatives. K2.6 is the current default fallback in the primary Sisyphus chain; many users run K2.6 or the K2.5/K2.6 combo exclusively. - **GLM 5** — Solid option, especially via Z.ai. -Sisyphus works best on Claude Opus 4.7, Kimi K2.5, and GLM 5. GPT-5.4 and GPT-5.5 now have dedicated prompt paths, but older GPT models are still a poor fit and should route to Hephaestus instead. +Sisyphus works best on Claude Opus 4.7, Kimi K2.6 (or K2.5), and GLM 5.1. GPT-5.4 and GPT-5.5 now have dedicated prompt paths, but older GPT models are still a poor fit and should route to Hephaestus instead. ### Hephaestus: The Legitimate Craftsman @@ -170,7 +170,7 @@ You can override specific agents or categories in your config: "$schema": "https://raw.githubusercontent.com/code-yeongyu/oh-my-openagent/dev/assets/oh-my-opencode.schema.json", "agents": { - // Main orchestrator: Claude Opus or Kimi K2.5 work best + // Main orchestrator: Claude Opus or Kimi K2.6 work best "sisyphus": { "model": "kimi-for-coding/k2p5", "ultrawork": { "model": "anthropic/claude-opus-4-7", "variant": "max" }, @@ -220,7 +220,7 @@ You can override specific agents or categories in your config: **Claude-like models** (instruction-following, structured output): - Claude Opus 4.7, Claude Haiku 4.5 -- Kimi K2.5 — behaves very similarly to Claude +- Kimi K2.6 / K2.5 — behaves very similarly to Claude - GLM 5 — Claude-like behavior, good for broad tasks **GPT models** (explicit reasoning, principle-driven): diff --git a/docs/reference/features.md b/docs/reference/features.md index 0cbd05945..d3bf03776 100644 --- a/docs/reference/features.md +++ b/docs/reference/features.md @@ -6,7 +6,7 @@ Oh-My-OpenAgent provides 11 specialized AI agents. Each has distinct expertise, ### Core Agents -Core-agent tab cycling is deterministic via injected runtime order field. The fixed priority order is Sisyphus (order: 1), Hephaestus (order: 2), Prometheus (order: 3), and Atlas (order: 4). Remaining agents follow after that stable core ordering. +Core-agent tab cycling is deterministic via injected runtime order field. The fixed priority order is Sisyphus (order: 0), Hephaestus (order: 1), Prometheus (order: 2), and Atlas (order: 3). Remaining agents follow after that stable core ordering. | Agent | Model | Purpose | | --------------------- | ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |