docs(readme): document the code docs (wiki) feature#315
Conversation
The per-file/per-subsystem code docs feature (hivemind docs sync/list/auto/ agent, install onboarding, background generation) was undocumented. Add a concise section under Codebase graph covering the commands, the async/ no-API-key generation, and agent resolution.
📝 WalkthroughWalkthroughREADME adds a “Code docs (wiki)” section describing wiki generation from the codebase graph, ChangesCode documentation workflow
Estimated code review effort: 1 (Trivial) | ~2 minutes Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Coverage ReportNo Generated for commit 9037f9b. |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Around line 462-465: Update the agent-resolution sentence in the README to
include HIVEMIND_DOCS_LLM_BIN as the environment variable for configuring a
custom host CLI, alongside the existing built-in agent resolution and precedence
details.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro Plus
Run ID: 03114365-29b9-4bbe-a779-21f3b480f95f
📒 Files selected for processing (1)
README.md
| hivemind docs agent [name] # which host CLI writes the docs (claude|codex|pi|cursor) | ||
| ``` | ||
|
|
||
| Generation shells out to a host agent's own CLI (`claude -p`, `codex exec`, …) — no separate API key — and runs **in the background**, so it never blocks. `hivemind install` inside a git repo offers to set this up for you. The agent is resolved as `HIVEMIND_DOCS_LLM_AGENT` (env) > `docs.llmAgent` (config) > auto-detect; per-file docs use a cheap model, wiki pages a stronger one. |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Document the custom-agent escape hatch.
src/commands/docs.ts:353-384 supports arbitrary host CLIs through HIVEMIND_DOCS_LLM_BIN, but the README only lists the built-in agents. Add this variable to the agent-resolution sentence so users of other CLIs can configure the feature.
Suggested documentation update
- The agent is resolved as `HIVEMIND_DOCS_LLM_AGENT` (env) > `docs.llmAgent` (config) > auto-detect;
+ The agent is resolved as `HIVEMIND_DOCS_LLM_AGENT` (env) > `docs.llmAgent` (config) > auto-detect;
+ use `HIVEMIND_DOCS_LLM_BIN` to configure any other host CLI.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| hivemind docs agent [name] # which host CLI writes the docs (claude|codex|pi|cursor) | |
| ``` | |
| Generation shells out to a host agent's own CLI (`claude -p`, `codex exec`, …) — no separate API key — and runs **in the background**, so it never blocks. `hivemind install` inside a git repo offers to set this up for you. The agent is resolved as `HIVEMIND_DOCS_LLM_AGENT` (env) > `docs.llmAgent` (config) > auto-detect; per-file docs use a cheap model, wiki pages a stronger one. |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@README.md` around lines 462 - 465, Update the agent-resolution sentence in
the README to include HIVEMIND_DOCS_LLM_BIN as the environment variable for
configuring a custom host CLI, alongside the existing built-in agent resolution
and precedence details.
Adds a concise Code docs (wiki) section under Codebase graph — the whole
hivemind docsfeature (sync/list/auto/agent, install onboarding, background generation, agent resolution) was undocumented.README-only; no code changes.
Codex review skipped for a pure-docs prose change (no logic to review) — say the word if you want it anyway.
Summary by CodeRabbit