Repository navigation
Docs: surface the reranker + close v2.7.0 doc gaps (tags, MCP tool list/resources/prompts) + guardrail test - #52
Merged
Merged
Conversation
…rail test Close the documentation gaps that accumulated across v2.7.0 features: - book/src/local-only.md: add optional reranker section (qwen3:4b, setup, RAM cost, when it helps) between the Verify step and local MCP client section - book/src/searching.md: add "Managing tags" section covering `journal tags` and `journal tags rename` - book/src/integrations/claude-desktop.md: add 4 missing tools (stats, today, ask, synth) to the tool table; add resources (journal://today/recent/projects) and prompts (weekly-reflection, decisions-review, project-status) sections - book/src/integrations/claude-code.md: add "Using the MCP server" section - README.md: update integrations bullet to full 13-tool summary; add reranker hint to Ollama requirement; add journal tags to commands table - docs/USAGE.md: add journal tags and tags rename to command surface; add Tags section with usage examples; expand MCP reference to all 13 tools, resources, and prompts - docs/INTEGRATIONS.md: add MCP resources and prompts subsections after the tool table in §3b - cmd/mcp_test.go: add TestMCPDocCoverage guardrail — asserts every registered tool, resource URI, and prompt name appears in README, INTEGRATIONS.md, and claude-desktop.md; CI fails if docs drift from the MCP surface again Closes #51 Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Contributor
Author
|
Retro: no durable lesson (merged clean / one-off). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
🤖 Agent-Generated PR
Closes #51
Agent Used: Claude Sonnet 4.6
Complexity: medium
Summary
Close the documentation gaps that accumulated across v2.7.0 features. Every item from the issue's audit is addressed: reranker setup,
journal tags, the full 13-tool MCP list, MCP resources, MCP prompts, and a CI guardrail test so this can't silently drift again.Implementation Notes
synthtool (run a synthesis digest, return text) for reflection/Slack workflows #46 (synth tool in SYNTHESIS.md) for each new surfacecmd/mcp_test.go— it reads the registered tool/resource/prompt names from a hardcoded list (the "shared list" option from the issue) and asserts each appears in README, INTEGRATIONS.md, and claude-desktop.md. Future additions require updating the list AND the docs, or CI fails.docs/INTEGRATIONS.md§3b tool table was already complete (13 tools) — only resources and prompts were missing thereqwen3:4b) matches what's already in DECISIONS.md and CONFIGURATION.mdChanges
book/src/local-only.md— add optional reranker section (model, config key, RAM cost)book/src/searching.md— add "Managing tags" section forjournal tagsandtags renamebook/src/integrations/claude-desktop.md— add 4 missing tools (stats, today, ask, synth); add resources and prompts sectionsbook/src/integrations/claude-code.md— add "Using the MCP server" section with config snippetREADME.md— update integrations bullet; add reranker hint; addjournal tagsto commands tabledocs/USAGE.md— addjournal tagsto command surface; add Tags section; expand MCP referencedocs/INTEGRATIONS.md— add MCP resources and prompts subsections after the tool tablecmd/mcp_test.go— addTestMCPDocCoverageguardrail testTesting
Automated:
TestMCPDocCoverage)Manual testing performed:
Review Checklist
Correctness
Code Quality
-p 1Reviewer Notes
The only acceptance criterion not checked off on the issue is "mdbook build clean (no broken links); existing tests pass; lint passes; review approved" — those require CI and human review.