Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
efenocchi merged 1 commit into from
Jul 15, 2026
Merged

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -451,6 +451,19 @@ Hivemind builds a live graph of your codebase from the same traces it captures:

Above: the Hivemind codebase rendered through its own graph feature.

## Code docs (wiki)

From that graph, Hivemind can generate natural-language documentation for a repo — one page per file, plus narrative wiki pages per subsystem — and keep it fresh on every commit. Agents read it (`~/.deeplake/memory/docs/`) to orient before touching code.

```bash
hivemind docs sync # generate/refresh docs for this repo (asks first)
hivemind docs list # status: enabled? pages? in sync with HEAD?
hivemind docs auto on|off # keep docs fresh automatically on each commit
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.
Comment on lines +462 to +465

@coderabbitai coderabbitai Bot Jul 15, 2026

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.


## Rules (cross-agent team principles)

Hivemind **shares team rules across every agent in the org**, injected at SessionStart so every claude-code / cursor / hermes session starts knowing them. For personal or team work items with progress tracking, use [Goals + KPIs](#goals--kpis) (VFS-backed) instead.
Expand Down