mirror of
https://github.com/thedotmack/claude-mem
synced 2026-04-25 17:15:04 +02:00
4df9f61347
* fix: stop generating empty CLAUDE.md files - Return empty string instead of "No recent activity" when no observations exist - Skip writing CLAUDE.md files when formatted content is empty - Remove redundant "auto-generated by claude-mem" HTML comment - Clean up 98 existing empty CLAUDE.md files across the codebase - Update tests to expect empty string for empty input Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * build assets * refactor: implement in-process worker architecture for hooks Replaces spawn-based worker startup with in-process architecture: - Hook processes now become the worker when port 37777 is free - Eliminates Windows spawn issues (NO SPAWN rule) - SessionStart chains: smart-install && stop && context Key changes: - worker-service.ts: hook case starts WorkerService in-process - hook-command.ts: skipExit option prevents process.exit() when hosting worker - hooks.json: single chained command replaces separate start/hook commands - worker-utils.ts: ensureWorkerRunning() returns boolean, doesn't block - handlers: graceful fallback when worker unavailable All 761 tests pass. Manual verification confirms hook stays alive as worker. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * context * a * MAESTRO: Mark PR #722 test verification task complete All 797 tests passed (3 skipped, 0 failed) after merge conflict resolution. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * MAESTRO: Mark PR #722 build verification task complete * MAESTRO: Mark PR #722 code review task complete Code review verified: - worker-service.ts hook case starts WorkerService in-process - hook-command.ts has skipExit option - hooks.json uses single chained command - worker-utils.ts ensureWorkerRunning() returns boolean Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * MAESTRO: Mark PR #722 conflict resolution push task complete Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
2.9 KiB
2.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
.mdxformat (Markdown with JSX support) - Listed in
docs.jsonnavigation 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
- Create a new
.mdxfile in the appropriate subdirectory - Add the file path to
docs.jsonnavigation - Use Mintlify's frontmatter and components
- Follow the existing documentation style
- Test locally:
npx mintlify dev
Development Workflow
For contributors working on claude-mem:
- Read
/CLAUDE.mdin 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