mcp-adr-analysis-server

# 📝 Documentation Notes & Drafts **⚠️ DRAFT CONTENT** - This directory contains draft documentation, design notes, and work-in-progress content. --- ## ⚠️ Important Notice This `notes/` directory contains: - **Draft documentation** that may be incomplete - **Design notes** and brainstorming - **Work-in-progress** content - **Archived content** that may be outdated **For stable, production-ready documentation**, please see: - **[Main Documentation](../README.md)** - Start here - **[Tutorials](../tutorials/)** - Step-by-step guides - **[How-To Guides](../how-to-guides/)** - Task-focused instructions - **[Reference](../reference/)** - API and configuration reference - **[Explanation](../explanation/)** - Conceptual documentation --- ## 📂 Directory Structure ### Active Development - `performance-design.md` - Performance architecture notes - `tool-design.md` - Tool design patterns - `knowledge-graph.md` - Knowledge graph design - `prompt-engineering.md` - Prompting strategies **Note**: These files have been moved to `/docs/explanation/` for production use. ### Archive / Draft Content - `media/` - Older/draft versions of documentation - `USER_GUIDANCE.md` - Draft user guidance - `DEVELOPER_GUIDANCE.md` - Draft developer guidance - `research-*.md` - Research notes and integration drafts --- ## 🔄 Migration Status Files in this directory are being migrated to appropriate locations: | File | Status | New Location | | ----------------------- | -------------- | ----------------------------------------- | | `performance-design.md` | ✅ Migrated | `/docs/explanation/performance-design.md` | | `tool-design.md` | ✅ Migrated | `/docs/explanation/tool-design.md` | | `knowledge-graph.md` | ✅ Migrated | `/docs/explanation/knowledge-graph.md` | | `prompt-engineering.md` | ✅ Migrated | `/docs/explanation/prompt-engineering.md` | | Others | 🔄 In Progress | TBD | --- ## 📖 Using This Directory ### For Contributors If you're working on new documentation: 1. **Create drafts here** during development 2. **Link carefully** - use absolute paths or expect broken links 3. **Move to proper location** when content is stable 4. **Update references** after moving ### For Readers - **Don't rely on content here** for production use - **Check main docs first** for stable content - **Report issues** if you find outdated content --- ## 🗑️ Cleanup Plan This directory will be cleaned up according to the following plan: 1. **Phase 1** (Completed): Migrate core explanation files 2. **Phase 2** (In Progress): Review and consolidate draft content 3. **Phase 3** (Planned): Archive or remove obsolete content 4. **Phase 4** (Planned): Establish clear draft workflow --- ## 📚 Related Documentation - **[Contributing Guide](../../CONTRIBUTING.md)** - How to contribute - **[Documentation Structure](../diataxis-index.md)** - How docs are organized - **[Style Guide](../community/DOCUMENTATION_STYLE_GUIDE.md)** - Writing guidelines --- **Last Updated**: 2025-10-12 **Status**: Active cleanup in progress --- _For questions about this directory, see [Documentation Issues](https://github.com/tosin2013/mcp-adr-analysis-server/issues)_