Files
claude-mem/docs/public/CLAUDE.md
T
Alex Newman a3d6bfc7dd feat: Update CLAUDE.md files with recent test activities and improvements
- Added detailed entries for test activities across various modules including `export-types.test.ts`, `server.test.ts`, `smart-install.test.ts`, and others.
- Documented significant changes in test coverage, cleanup efforts, and regression tests.
- Enhanced the `plans` documentation with recent implementation strategies and PR follow-ups.
- Introduced a comprehensive report on Windows platform challenges and solutions, detailing issues like zombie ports, console popups, and process management.
- Established a new `ProcessManager` architecture to address Windows-specific issues and improve reliability.
- Updated integration tests to reflect recent changes and ensure comprehensive coverage.
2026-01-07 16:53:02 -05:00

9.9 KiB

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

# 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
# Recent Activity

Dec 28, 2025

platform-integration.mdx

ID Time T Title Read
#33540 10:55 PM 🔵 Grep search found mem-search references in internationalized documentation ~577
#33522 10:46 PM 🔵 Platform integration documentation describes Worker API architecture ~351

docs.json

ID Time T Title Read
#33312 3:09 PM OpenRouter Provider Documentation ~497

Dec 29, 2025

docs.json

ID Time T Title Read
#34321 11:03 PM 🔵 Mintlify Navigation Configuration Defines Expected File Paths ~330
#34215 10:08 PM 🔵 Retrieved Detailed Cursor Integration Implementation History ~676
#34148 9:28 PM 🟣 Cursor IDE Integration with Cross-Platform Hooks and Documentation ~514
#34112 9:07 PM 🟣 Committed Cursor Public Documentation to Repository ~427
#34108 9:06 PM 🟣 Added Cursor Integration Section to Documentation Navigation ~441
#34101 9:04 PM 🔵 Documentation Navigation Configuration Using Mintlify ~445

public

ID Time T Title Read
#34318 11:03 PM 🔵 Mintlify Documentation Files and Configuration Located ~294

installation.mdx

ID Time T Title Read
#34102 9:04 PM 🔵 Current Installation Documentation Targets Claude Code Plugin Users ~485

progressive-disclosure.mdx

ID Time T Title Read
#33773 12:38 AM Replaced two-tier with three-layer workflow documentation ~431
#33772 " Updated progressive disclosure docs with 3-layer MCP workflow ~399
#33771 12:37 AM 🔵 Progressive disclosure design rationale documented ~508
#33770 " 🔵 Progressive disclosure documentation reviewed ~479
#33715 12:18 AM Future enhancements section updated for current API structure ~308
#33712 " Progressive disclosure docs updated to reflect 3-layer workflow ~363
#33702 12:09 AM ⚖️ Documentation Update Strategy Finalized for MCP Architecture Transition ~845
#33696 12:07 AM 🔵 Progressive Disclosure Philosophy Requires Tool Name Updates ~687
#33685 12:04 AM 🔵 Progressive Disclosure Philosophy Document References Deprecated Tools ~543

architecture-evolution.mdx

ID Time T Title Read
#33763 12:27 AM Pull request #480 created for MCP architecture documentation updates ~423
#33760 12:26 AM Major documentation overhaul across 6 files with 908 additions ~367
#33749 12:25 AM Documentation Version Reference Removed ~282
#33747 " Removed specific version reference from MCP architecture section ~279
#33745 " Documentation Version Reference Simplified ~224
#33744 " Removed fabricated version number from architecture documentation ~319
#33726 12:20 AM 🟣 v6.5.0 architecture evolution documentation added ~599
#33700 12:08 AM 🔵 Architecture Evolution Document Contains Historical MCP Tool References ~625

troubleshooting.mdx

ID Time T Title Read
#33722 12:19 AM Token limit troubleshooting completely rewritten for 3-layer workflow ~426
#33720 " Troubleshooting search query examples updated to current API ~329
#33717 " 🔵 Troubleshooting docs contain outdated search_observations references ~333
#33693 12:06 AM 🔵 Troubleshooting Documentation Contains Deprecated Search Tool Syntax ~576

introduction.mdx

ID Time T Title Read
#33687 12:05 AM 🔵 Introduction Documentation References mem-search Skill ~426

Dec 31, 2025

troubleshooting.mdx

ID Time T Title Read
#34688 3:40 PM 🔵 Worker Logs Command Usage Across Codebase ~320

Jan 1, 2026

context-engineering.mdx

ID Time T Title Read
#35459 8:57 PM 🔵 Existing Coding Standards and Anti-Pattern References in Codebase ~600

Jan 2, 2026

architecture-evolution.mdx

ID Time T Title Read
#36096 10:23 PM 🔵 Observation API Function Names Located ~227

Jan 3, 2026

architecture-evolution.mdx

ID Time T Title Read
#36353 8:42 PM 🔵 Multiple observation table definitions found across codebase ~280

Jan 4, 2026

hooks-architecture.mdx

ID Time T Title Read
#36941 2:43 AM 🔵 Context Injection Header Format ~220

Jan 5, 2026

CLAUDE.md

ID Time T Title Read
#38082 10:13 PM Merge Conflict Resolution - Kept Feature Branch Versions ~431

progressive-disclosure.mdx

ID Time T Title Read
#38069 9:51 PM 🔵 Progressive Disclosure Philosophy Documentation ~546

docs.json

ID Time T Title Read
#38066 9:50 PM v9.0 Documentation Audit Completed with 14 Files Updated ~547
#38064 " ⚖️ 9.0 Release Documentation Audit Complete - Major Gaps Identified ~997
#38035 9:42 PM 🔵 Documentation Navigation Structure for 9.0 Release ~422

modes.mdx

ID Time T Title Read
#38060 9:49 PM 🔵 Modes System Documentation for Workflow and Language Configuration ~514

configuration.mdx

ID Time T Title Read
#38054 9:47 PM 🔵 Configuration Documentation Review - Missing Live Context Settings ~530

platform-integration.mdx

ID Time T Title Read
#38052 9:46 PM 🔵 Platform Integration Documentation Review ~525

hooks-architecture.mdx

ID Time T Title Read
#38045 9:45 PM 🔵 Hooks Architecture Documentation Review ~520

introduction.mdx

ID Time T Title Read
#38044 9:44 PM 🔵 Introduction Documentation Review for 9.0 Release ~462

context-engineering.mdx

ID Time T Title Read
#38043 9:44 PM 🔵 Context Engineering Documentation Review ~455

troubleshooting.mdx

ID Time T Title Read
#37548 4:48 PM Issue #543 Analysis Report Created for Slash Command Availability ~540