Skip to content

docs(readme): document the code docs (wiki) feature#315

Merged
efenocchi merged 1 commit into
mainfrom
docs/readme-code-docs
Jul 15, 2026
Merged

docs(readme): document the code docs (wiki) feature#315
efenocchi merged 1 commit into
mainfrom
docs/readme-code-docs

Conversation

@efenocchi

@efenocchi efenocchi commented Jul 15, 2026

Copy link
Copy Markdown
Collaborator

Adds a concise Code docs (wiki) section under Codebase graph — the whole hivemind docs feature (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

  • Documentation
    • Added a “Code docs (wiki)” section describing how to generate and synchronize documentation pages.
    • Documented options for automatic updates, checking documentation status, and configuring the documentation provider.
    • Clarified background generation and setup through the installation workflow.

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.
@coderabbitai

coderabbitai Bot commented Jul 15, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

README adds a “Code docs (wiki)” section describing wiki generation from the codebase graph, hivemind docs commands, background execution through a host CLI, and setup during hivemind install.

Changes

Code documentation workflow

Layer / File(s) Summary
Document code wiki workflow
README.md
Documents per-file and subsystem wiki generation, sync and status commands, automatic refresh settings, host-agent selection, background CLI execution, and installation setup in git repositories.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Suggested reviewers: kaghni, khustup2

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly matches the README docs/wiki documentation update and is concise.
Description check ✅ Passed It includes a solid Summary and notes the change is README-only, but it omits the template's Version Bump and Test plan sections.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/readme-code-docs

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@github-actions

Copy link
Copy Markdown
Contributor

Coverage Report

No src/*.ts files changed in this PR.

Generated for commit 9037f9b.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between c01029a and 2055842.

📒 Files selected for processing (1)
  • README.md

Comment thread README.md
Comment on lines +462 to +465
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.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📐 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.

Suggested change
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.

@efenocchi
efenocchi merged commit f882b29 into main Jul 15, 2026
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant