Alex Newman
2659ec3231
* Refactor CLAUDE.md and related files for December 2025 updates - Updated CLAUDE.md in src/services/worker with new entries for December 2025, including changes to Search.ts, GeminiAgent.ts, SDKAgent.ts, and SessionManager.ts. - Revised CLAUDE.md in src/shared to reflect updates and new entries for December 2025, including paths.ts and worker-utils.ts. - Modified hook-constants.ts to clarify exit codes and their behaviors. - Added comprehensive hooks reference documentation for Claude Code, detailing usage, events, and examples. - Created initial CLAUDE.md files in various directories to track recent activity. * fix: Merge user-message-hook output into context-hook hookSpecificOutput - Add footer message to additionalContext in context-hook.ts - Remove user-message-hook from SessionStart hooks array - Fixes issue where stderr+exit(1) approach was silently discarded Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * Update logs and documentation for recent plugin and worker service changes - Added detailed logs for worker service activities from Dec 10, 2025 to Jan 7, 2026, including initialization patterns, cleanup confirmations, and diagnostic logging. - Updated plugin documentation with recent activities, including plugin synchronization and configuration changes from Dec 3, 2025 to Jan 7, 2026. - Enhanced the context hook and worker service logs to reflect improvements and fixes in the plugin architecture. - Documented the migration and verification processes for the Claude memory system and its integration with the marketplace. * Refactor hooks architecture and remove deprecated user-message-hook - Updated hook configurations in CLAUDE.md and hooks.json to reflect changes in session start behavior. - Removed user-message-hook functionality as it is no longer utilized in Claude Code 2.1.0; context is now injected silently. - Enhanced context-hook to handle session context injection without user-visible messages. - Cleaned up documentation across multiple files to align with the new hook structure and removed references to obsolete hooks. - Adjusted timing and command execution for hooks to improve performance and reliability. * fix: Address PR #610 review issues - Replace USER_MESSAGE_ONLY test with BLOCKING_ERROR test in hook-constants.test.ts - Standardize Claude Code 2.1.0 note wording across all three documentation files - Exclude deprecated user-message-hook.ts from logger-usage-standards test Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix: Remove hardcoded fake token counts from context injection Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * Address PR #610 review issues by fixing test files, standardizing documentation notes, and verifying code quality improvements. * fix: Add path validation to CLAUDE.md distribution to prevent invalid directory creation - Add isValidPathForClaudeMd() function to reject invalid paths: - Tilde paths (~) that Node.js doesn't expand - URLs (http://, https://) - Paths with spaces (likely command text or PR references) - Paths with # (GitHub issue/PR references) - Relative paths that escape project boundary - Integrate validation in updateFolderClaudeMdFiles loop - Add 6 unit tests for path validation - Update .gitignore to prevent accidental commit of malformed directories - Clean up existing invalid directories (~/, PR #610..., git diff..., https:) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> * fix: Implement path validation in CLAUDE.md generation to prevent invalid directory creation - Added `isValidPathForClaudeMd()` function to validate file paths in `src/utils/claude-md-utils.ts`. - Integrated path validation in `updateFolderClaudeMdFiles` to skip invalid paths. - Added 6 new unit tests in `tests/utils/claude-md-utils.test.ts` to cover various rejection cases. - Updated `.gitignore` to prevent tracking of invalid directories. - Cleaned up existing invalid directories in the repository. * feat: Promote critical WARN logs to ERROR level across codebase Comprehensive log-level audit promoting 38+ WARN messages to ERROR for improved debugging and incident response: - Parser: observation type errors, data contamination - SDK/Agents: empty init responses (Gemini, OpenRouter) - Worker/Queue: session recovery, auto-recovery failures - Chroma: sync failures, search failures (now treated as critical) - SQLite: search failures (primary data store) - Session/Generator: failures, missing context - Infrastructure: shutdown, process management failures - File Operations: CLAUDE.md updates, config reads - Branch Management: recovery checkout failures Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> * fix: Address PR #614 review issues - Remove incorrectly tracked tilde-prefixed files from git - Fix absolute path validation to check projectRoot boundaries - Add test coverage for absolute path validation edge cases Closes review issues: - Issue 1: ~/ prefixed files removed from tracking - Issue 3: Absolute paths now validated against projectRoot - Issue 4: Added 3 new test cases for absolute path scenarios Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * build assets and context --------- Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
176 lines
6.6 KiB
Markdown
176 lines
6.6 KiB
Markdown
# Claude-Mem Public Documentation
|
|
|
|
## What This Folder Is
|
|
|
|
This `docs/public/` folder contains the **Mintlify documentation site** - the official user-facing documentation for claude-mem. It's a structured documentation platform with a specific file format and organization.
|
|
|
|
## Folder Structure
|
|
|
|
```
|
|
docs/
|
|
├── public/ ← You are here (Mintlify MDX files)
|
|
│ ├── *.mdx - User-facing documentation pages
|
|
│ ├── docs.json - Mintlify configuration and navigation
|
|
│ ├── architecture/ - Technical architecture docs
|
|
│ ├── usage/ - User guides and workflows
|
|
│ └── *.webp, *.gif - Assets (logos, screenshots)
|
|
└── context/ ← Internal documentation (DO NOT put here)
|
|
└── *.md - Planning docs, audits, references
|
|
```
|
|
|
|
## File Requirements
|
|
|
|
### Mintlify Documentation Files (.mdx)
|
|
All official documentation files must be:
|
|
- Written in `.mdx` format (Markdown with JSX support)
|
|
- Listed in `docs.json` navigation structure
|
|
- Follow Mintlify's schema and conventions
|
|
|
|
The documentation is organized into these sections:
|
|
- **Get Started**: Introduction, installation, usage guides
|
|
- **Best Practices**: Context engineering, progressive disclosure
|
|
- **Configuration & Development**: Settings, dev workflow, troubleshooting
|
|
- **Architecture**: System design, components, technical details
|
|
|
|
### Configuration File
|
|
`docs.json` defines:
|
|
- Site metadata (name, description, theme)
|
|
- Navigation structure
|
|
- Branding (logos, colors)
|
|
- Footer links and social media
|
|
|
|
## What Does NOT Belong Here
|
|
|
|
**Planning documents, design docs, and reference materials go in `/docs/context/` instead:**
|
|
|
|
Files that belong in `/docs/context/` (NOT here):
|
|
- Planning documents (`*-plan.md`, `*-outline.md`)
|
|
- Implementation analysis (`*-audit.md`, `*-code-reference.md`)
|
|
- Error tracking (`typescript-errors.md`)
|
|
- Internal design documents
|
|
- PR review responses
|
|
- Reference materials (like `agent-sdk-ref.md`)
|
|
- Work-in-progress documentation
|
|
|
|
## How to Add Official Documentation
|
|
|
|
1. Create a new `.mdx` file in the appropriate subdirectory
|
|
2. Add the file path to `docs.json` navigation
|
|
3. Use Mintlify's frontmatter and components
|
|
4. Follow the existing documentation style
|
|
5. Test locally: `npx mintlify dev`
|
|
|
|
## Development Workflow
|
|
|
|
**For contributors working on claude-mem:**
|
|
- Read `/CLAUDE.md` in the project root for development instructions
|
|
- Place planning/design docs in `/docs/context/`
|
|
- Only add user-facing documentation to `/docs/public/`
|
|
- Test documentation locally with Mintlify CLI before committing
|
|
|
|
## Testing Documentation
|
|
|
|
```bash
|
|
# Validate docs structure
|
|
npx mintlify validate
|
|
|
|
# Check for broken links
|
|
npx mintlify broken-links
|
|
|
|
# Run local dev server
|
|
npx mintlify dev
|
|
```
|
|
|
|
## Summary
|
|
|
|
**Simple Rule**:
|
|
- `/docs/public/` = Official user documentation (Mintlify .mdx files) ← YOU ARE HERE
|
|
- `/docs/context/` = Internal docs, plans, references, audits
|
|
|
|
|
|
<claude-mem-context>
|
|
# Recent Activity
|
|
|
|
<!-- This section is auto-generated by claude-mem. Edit content outside the tags. -->
|
|
|
|
### Nov 18, 2025
|
|
|
|
| ID | Time | T | Title | Read |
|
|
|----|------|---|-------|------|
|
|
| #11206 | 3:01 PM | 🔵 | mem-search skill architecture and migration details retrieved in full format | ~538 |
|
|
|
|
### Nov 21, 2025
|
|
|
|
| ID | Time | T | Title | Read |
|
|
|----|------|---|-------|------|
|
|
| #13221 | 2:01 AM | 🔴 | Fixed broken markdown link to Viewer UI documentation | ~316 |
|
|
| #13220 | 2:00 AM | 🔴 | Escaped HTML less-than symbol in universal architecture timeout documentation | ~316 |
|
|
| #13216 | 1:54 AM | ✅ | Universal Architecture Added to Navigation | ~330 |
|
|
| #13215 | " | 🟣 | Universal AI Memory Architecture Documentation Created | ~732 |
|
|
| #13213 | 1:50 AM | 🔵 | Introduction Page Content and Recent v6.0.0 Release | ~495 |
|
|
| #13212 | " | 🔵 | Architecture Evolution Documentation Structure | ~408 |
|
|
| #13211 | " | 🔵 | Mintlify Documentation Site Configuration | ~430 |
|
|
| #13209 | 1:48 AM | 🔵 | Public Documentation Structure and Guidelines | ~383 |
|
|
|
|
### Nov 25, 2025
|
|
|
|
| ID | Time | T | Title | Read |
|
|
|----|------|---|-------|------|
|
|
| #14994 | 2:22 PM | ✅ | Version Channel Section Added to Configuration Documentation | ~301 |
|
|
| #14993 | " | ✅ | Beta Features Added to Documentation Navigation | ~188 |
|
|
| #14992 | 2:21 PM | 🟣 | Beta Features Documentation Page Created | ~488 |
|
|
| #14991 | " | 🔵 | Mintlify Navigation Structure and Documentation Groups | ~394 |
|
|
| #14989 | " | 🔵 | Installation Documentation with Quick Start and Verification Steps | ~383 |
|
|
| #14988 | " | 🔵 | Configuration Documentation Structure and Environment Variables | ~338 |
|
|
|
|
### Nov 26, 2025
|
|
|
|
| ID | Time | T | Title | Read |
|
|
|----|------|---|-------|------|
|
|
| #16190 | 10:22 PM | 🔵 | RAGTIME Search Retrieved Five Observations About Claude-Mem vs RAG Architecture | ~637 |
|
|
|
|
### Dec 3, 2025
|
|
|
|
| ID | Time | T | Title | Read |
|
|
|----|------|---|-------|------|
|
|
| #19884 | 9:42 PM | 🔵 | Configuration system and environment variables | ~701 |
|
|
| #19878 | 9:40 PM | 🔵 | Installation process and system architecture | ~486 |
|
|
|
|
### Dec 8, 2025
|
|
|
|
| ID | Time | T | Title | Read |
|
|
|----|------|---|-------|------|
|
|
| #22335 | 10:26 PM | 🔵 | Mintlify documentation configuration analyzed | ~534 |
|
|
| #22311 | 9:47 PM | 🔵 | Comprehensive Hooks Architecture Documentation Review | ~263 |
|
|
| #22297 | 9:43 PM | 🔵 | Mintlify Documentation Framework Configuration | ~446 |
|
|
| #22294 | " | 🔵 | Documentation Site Structure Located | ~359 |
|
|
|
|
### Dec 9, 2025
|
|
|
|
| ID | Time | T | Title | Read |
|
|
|----|------|---|-------|------|
|
|
| #23179 | 10:44 PM | ✅ | Removed explanatory reasons from tool exclusion documentation | ~297 |
|
|
|
|
### Dec 15, 2025
|
|
|
|
| ID | Time | T | Title | Read |
|
|
|----|------|---|-------|------|
|
|
| #27038 | 6:02 PM | 🔵 | 95% token reduction claims found only in private experimental documents, not in main public docs | ~513 |
|
|
| #27037 | " | 🔵 | Branch switching functionality exists in SettingsRoutes with UI switcher removal intent | ~463 |
|
|
| #26986 | 5:24 PM | ✅ | Updated Endless Mode latency warning in beta features documentation | ~299 |
|
|
|
|
### Dec 29, 2025
|
|
|
|
| ID | Time | T | Title | Read |
|
|
|----|------|---|-------|------|
|
|
| #33938 | 6:27 PM | 🔵 | Relevant CLAUDE.md Context Identified for PR #492 | ~435 |
|
|
| #33750 | 12:25 AM | ✅ | Documentation Update: Removed Version Number from Architecture Evolution | ~281 |
|
|
|
|
### Jan 7, 2026
|
|
|
|
| ID | Time | T | Title | Read |
|
|
|----|------|---|-------|------|
|
|
| #38233 | 7:42 PM | ✅ | Renumbered SessionEnd Hook from 6 to 5 | ~315 |
|
|
| #38229 | 7:41 PM | ✅ | Renumbered PostToolUse Hook from 4 to 3 | ~278 |
|
|
| #38225 | " | ✅ | Updated Hook Count Description in Hooks Architecture Documentation | ~352 |
|
|
</claude-mem-context> |