From 7be2e9547562a93dd77cb14e480332be13bcaba4 Mon Sep 17 00:00:00 2001 From: Ali Turki Date: Fri, 3 Jul 2026 15:25:26 +0800 Subject: [PATCH] docs: explain brew relink step after in-app update to v0.6.0 Homebrew users who installed 0.5.1 and let the app self-update reach 0.6.0 without the docsreader-mcp PATH symlink, so the bare-command MCP registration fails with ENOENT. Tell them to run brew upgrade once, and point out that the in-app Connect flow writes the full binary path and is unaffected. --- README.md | 2 +- .../resources/welcome/Getting started/Connect your AI agents.md | 2 ++ 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 153a134..f61bdd9 100644 --- a/README.md +++ b/README.md @@ -68,7 +68,7 @@ Cursor (`~/.cursor/mcp.json`) and Windsurf (`~/.codeium/windsurf/mcp_config.json { "mcpServers": { "docsreader": { "command": "docsreader-mcp" } } } ``` -If `docsreader-mcp` is not on your PATH (macOS DMG install without Homebrew), use the full binary path from the table above instead. +If `docsreader-mcp` is not on your PATH (macOS DMG install without Homebrew), use the full binary path from the table above instead. Homebrew users who installed before v0.6.0 and auto-updated in-app: run `brew upgrade --cask docsreader` once so Homebrew links the binary - the in-app updater cannot do that. The in-app Connect flow always writes the full path, so it works regardless. Then tell your agents how to use it: copy the [AGENTS template](docs/AGENTS-TEMPLATE.md) into your repo's `AGENTS.md` or `CLAUDE.md`. diff --git a/src-tauri/resources/welcome/Getting started/Connect your AI agents.md b/src-tauri/resources/welcome/Getting started/Connect your AI agents.md index eccaa3a..0f9d230 100644 --- a/src-tauri/resources/welcome/Getting started/Connect your AI agents.md +++ b/src-tauri/resources/welcome/Getting started/Connect your AI agents.md @@ -29,6 +29,8 @@ Cursor (`~/.cursor/mcp.json`) and Windsurf (`~/.codeium/windsurf/mcp_config.json Installed from the macOS DMG without Homebrew? Use the full path instead: `/Applications/DocsReader.app/Contents/MacOS/docsreader-mcp`. +Installed with Homebrew before v0.6.0 and let the app update itself? Homebrew only links `docsreader-mcp` onto your PATH when the cask itself upgrades - run `brew upgrade --cask docsreader` once, or just use the one-click Connect above (it always writes the full path). + ## What agents do with it - **Docs** land in folders that mirror their lifecycle - `research/`, `in-progress/`, `done/`, `archived/`. The folder is the status; moving the file is the status change.