basher83
97d565e3cd
* feat: add mem-search skill with progressive disclosure architecture Add comprehensive mem-search skill for accessing claude-mem's persistent cross-session memory database. Implements progressive disclosure workflow and token-efficient search patterns. Features: - 12 search operations (observations, sessions, prompts, by-type, by-concept, by-file, timelines, etc.) - Progressive disclosure principles to minimize token usage - Anti-patterns documentation to guide LLM behavior - HTTP API integration for all search functionality - Common workflows with composition examples Structure: - SKILL.md: Entry point with temporal trigger patterns - principles/: Progressive disclosure + anti-patterns - operations/: 12 search operation files 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> * docs: add CHANGELOG entry for mem-search skill Document mem-search skill addition in Unreleased section with: - 100% effectiveness compliance metrics - Comparison to previous search skill implementation - Progressive disclosure architecture details - Reference to audit report documentation 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> * docs: add mem-search skill audit report Add comprehensive audit report validating mem-search skill against Anthropic's official skill-creator documentation. Report includes: - Effectiveness metrics comparison (search vs mem-search) - Critical issues analysis for production readiness - Compliance validation across 6 key dimensions - Reference implementation guidance Result: mem-search achieves 100% compliance vs search's 67% 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> * feat: Add comprehensive search architecture analysis document - Document current state of dual search architectures (HTTP API and MCP) - Analyze HTTP endpoints and MCP search server architectures - Identify DRY violations across search implementations - Evaluate the use of curl as the optimal approach for search - Provide architectural recommendations for immediate and long-term improvements - Outline action plan for cleanup, feature parity, DRY refactoring * refactor: Remove deprecated search skill documentation and operations * refactor: Reorganize documentation into public and context directories Changes: - Created docs/public/ for Mintlify documentation (.mdx files) - Created docs/context/ for internal planning and implementation docs - Moved all .mdx files and assets to docs/public/ - Moved all internal .md files to docs/context/ - Added CLAUDE.md to both directories explaining their purpose - Updated docs.json paths to work with new structure Benefits: - Clear separation between user-facing and internal documentation - Easier to maintain Mintlify docs in dedicated directory - Internal context files organized separately 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> * Enhance session management and continuity in hooks - Updated new-hook.ts to clarify session_id threading and idempotent session creation. - Modified prompts.ts to require claudeSessionId for continuation prompts, ensuring session context is maintained. - Improved SessionStore.ts documentation on createSDKSession to emphasize idempotent behavior and session connection. - Refined SDKAgent.ts to detail continuation prompt logic and its reliance on session.claudeSessionId for unified session handling. --------- Co-authored-by: Claude <noreply@anthropic.com> Co-authored-by: Alex Newman <thedotmack@gmail.com>
105 lines
3.7 KiB
Markdown
105 lines
3.7 KiB
Markdown
# Claude-Mem Context Documentation
|
|
|
|
## What This Folder Is
|
|
|
|
This `docs/context/` folder contains **internal documentation** - planning documents, design references, audits, and work-in-progress materials that support development but are NOT user-facing.
|
|
|
|
## Folder Structure
|
|
|
|
```
|
|
docs/
|
|
├── public/ ← User-facing Mintlify docs (DO NOT put internal docs there)
|
|
│ └── *.mdx - Official documentation
|
|
└── context/ ← You are here (Internal documentation)
|
|
├── *.md - Planning docs, audits, references
|
|
├── *-plan.md - Implementation plans
|
|
├── *-audit.md - Code audits and reviews
|
|
├── agent-sdk-*.md - SDK reference materials
|
|
└── subdirs/ - Organized by topic
|
|
```
|
|
|
|
## What Belongs Here
|
|
|
|
**Internal Documentation** (`.md` format):
|
|
- Planning documents (`*-plan.md`, `*-outline.md`)
|
|
- Implementation analysis (`*-audit.md`, `*-code-reference.md`)
|
|
- Error tracking (`typescript-errors.md`)
|
|
- Design documents not ready for public docs
|
|
- PR review responses
|
|
- Reference materials (like `agent-sdk-ref.md`)
|
|
- Work-in-progress documentation
|
|
- Technical investigations and postmortems
|
|
- Architecture analysis documents
|
|
|
|
**Examples from this folder:**
|
|
- `mem-search-technical-architecture.md` - Deep technical reference
|
|
- `search-architecture-analysis.md` - Implementation analysis
|
|
- `agent-sdk-ref.md` - SDK reference for developers
|
|
- `typescript-errors.md` - Error tracking during development
|
|
- `worker-service-architecture.md` - Internal architecture notes
|
|
- `processing-indicator-audit.md` - Code audit document
|
|
|
|
## What Does NOT Belong Here
|
|
|
|
**User-Facing Documentation** goes in `/docs/public/`:
|
|
- User guides and tutorials
|
|
- Official architecture documentation
|
|
- Installation instructions
|
|
- Configuration guides
|
|
- Best practices for users
|
|
- Troubleshooting guides
|
|
|
|
**Rule of Thumb:**
|
|
- If a user would read it → `/docs/public/` (as `.mdx`)
|
|
- If only developers/contributors need it → `/docs/context/` (as `.md`)
|
|
|
|
## File Organization
|
|
|
|
### By Type
|
|
- `*-plan.md` - Implementation plans for features
|
|
- `*-audit.md` - Code audits and reviews
|
|
- `*-postmortem.md` - Analysis of issues or incidents
|
|
- `*-reference.md` - Technical reference materials
|
|
- `*-analysis.md` - Architecture or design analysis
|
|
|
|
### By Topic
|
|
- Create subdirectories for related documents
|
|
- Example: `claude-code/` for Claude Code specific docs
|
|
- Example: `architecture/` for internal architecture notes
|
|
|
|
## Development Workflow
|
|
|
|
### When to Create Context Docs
|
|
|
|
1. **Planning Phase** - Before implementing a feature
|
|
- Create `feature-name-plan.md`
|
|
- Outline implementation steps
|
|
- Document decisions and tradeoffs
|
|
|
|
2. **During Development** - Track issues and decisions
|
|
- Create `feature-name-audit.md` for code reviews
|
|
- Update `typescript-errors.md` for build issues
|
|
- Document gotchas in topic-specific files
|
|
|
|
3. **After Implementation** - Preserve knowledge
|
|
- Create `feature-name-postmortem.md` if issues occurred
|
|
- Update architecture analysis documents
|
|
- Archive plan docs (don't delete - useful for history)
|
|
|
|
### Graduating to Public Docs
|
|
|
|
When internal docs are polished enough for users:
|
|
1. Convert `.md` to `.mdx` format
|
|
2. Add Mintlify frontmatter
|
|
3. Move to appropriate `/docs/public/` subdirectory
|
|
4. Add to `docs.json` navigation
|
|
5. Keep original in `/docs/context/` for reference
|
|
|
|
## Summary
|
|
|
|
**Simple Rule**:
|
|
- `/docs/context/` = Internal docs, plans, references, audits ← YOU ARE HERE
|
|
- `/docs/public/` = Official user documentation (Mintlify .mdx files)
|
|
|
|
**Purpose**: This folder preserves development context, design decisions, and technical knowledge that helps contributors understand WHY things work the way they do, even if users don't need those details.
|