 Alex Newman
|
12459eab3b
|
docs: comprehensive v5.1.2 documentation update
This commit brings all documentation up to date with the current v5.1.2
codebase, addressing 12+ critical discrepancies and adding 2 major new
documentation files.
## Files Modified (18 documentation files):
### Root Documentation:
- README.md: Updated version badge (4.3.1 → 5.1.2), tool count (7 → 9),
added viewer UI and theme toggle features, updated "What's New" section
- CHANGELOG.md: Added 8 missing releases (v4.3.2 through v5.1.2) with
comprehensive release notes
- CLAUDE.md: Removed hardcoded personal paths, documented all 14 worker
endpoints (was 8), added Chroma integration overview, updated v5.x releases
### Mintlify Documentation (docs/):
- introduction.mdx: Updated search tool count to 9, added viewer UI and
theme toggle to features
- configuration.mdx: Added smart-install.js documentation, clarified data
directory locations, added CLAUDE_CODE_PATH env var, explained observations
vs sessions, updated hook configuration examples
- development.mdx: Added comprehensive viewer UI development section (103 lines),
updated build output filenames (search-server.mjs)
- usage/search-tools.mdx: Added get_context_timeline and get_timeline_by_query
documentation with examples, updated tool count to 9
- architecture/overview.mdx: Updated to 7 hook files, 9 search tools, added
Chroma to tech stack, enhanced component details with viewer UI
- architecture/hooks.mdx: Added smart-install.js and user-message-hook.js
documentation, updated hook count to 7
- architecture/worker-service.mdx: Documented all 14 endpoints organized by
category (Viewer & Health, Data Retrieval, Settings, Session Management)
- architecture/mcp-search.mdx: Added timeline tools documentation, updated
tool count to 9, fixed filename references (search-server.mjs)
- architecture-evolution.mdx: Added complete v5.x release history (v5.0.0
through v5.1.2), updated title to "v3 to v5"
- hooks-architecture.mdx: Updated to "Seven Hook Scripts", added smart-install
and user-message-hook documentation
- troubleshooting.mdx: Added v5.x specific issues section (viewer, theme toggle,
SSE, Chroma, PM2 Windows fix)
### New Documentation Files:
- docs/VIEWER.md: Complete 400+ line guide to web viewer UI including architecture,
features, usage, development, API integration, performance considerations
- docs/CHROMA.md: Complete 450+ line guide to vector database integration including
hybrid search architecture, semantic search explanation, performance benchmarks,
installation, configuration, troubleshooting
## Key Corrections Made:
1. ✅ Updated version badges and references: 4.3.1 → 5.1.2
2. ✅ Corrected search tool count: 7 → 9 (added get_context_timeline, get_timeline_by_query)
3. ✅ Fixed MCP server filename: search-server.js → search-server.mjs
4. ✅ Updated hook count: 5 → 7 (added smart-install.js, user-message-hook.js)
5. ✅ Documented all 14 worker endpoints (was 8, incorrectly claimed 6 were missing)
6. ✅ Removed hardcoded personal file paths
7. ✅ Added Chroma vector database documentation
8. ✅ Added viewer UI comprehensive documentation
9. ✅ Updated CHANGELOG with all missing v4.3.2-v5.1.2 releases
10. ✅ Clarified data directory locations (production vs development)
11. ✅ Added smart-install.js caching system documentation
12. ✅ Updated SessionStart hook configuration examples
## Documentation Statistics:
- Total files modified: 18
- New files created: 2
- Lines added: ~2,000+
- Version mismatches fixed: 2 critical
- Missing features documented: 5+ major
- Missing tools documented: 2 MCP tools
- Missing endpoints documented: 6 API endpoints
## Impact:
Documentation now accurately reflects the current v5.1.2 codebase with:
- Complete viewer UI documentation (v5.1.0)
- Theme toggle feature (v5.1.2)
- Hybrid search architecture with Chroma (v5.0.0)
- Smart install caching (v5.0.3)
- All 7 hook scripts documented
- All 9 MCP search tools documented
- All 14 worker service endpoints documented
- Comprehensive troubleshooting for v5.x issues
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <noreply@anthropic.com>
|
2025-11-06 13:59:10 -05:00 |
|