MindMeld Documentation Index

This comprehensive index helps both end users and developers find the right documentation quickly. Documents are organized by audience and purpose with clear navigation paths.

🚀 Quick Start Paths

For New Users

1. User Guide - Complete feature overview and usage instructions
2. Mobile Features - Touch interactions covered in User Guide

For New Developers

1. Developer Guide - Architecture, setup, and workflow overview
2. Testing Patterns - Comprehensive testing documentation
3. Coding Standards - Style and patterns

For Contributors

1. Contributing Guide - Code standards and contribution process
2. Git Workflow - Branching, versioning, and advanced Git scenarios

📚 Complete Documentation Catalog

👥 User Documentation

• User Guide - Complete feature overview and usage instructions
  • Basic features (notes, connections, colors)
  • Mobile and touch interactions
  • Tips and best practices

🛠️ Developer Documentation

Architecture & Design

• Developer Guide - System overview and navigation
• Adapter-Behavior Pattern - Input/business logic separation
• Data Providers - Storage abstraction layer
• Mobile Architecture - Touch system implementation

Development Practices

• Coding Standards - Style, patterns, and conventions
• Git Workflow - Branching, auto-versioning, and CI processes
• Testing Patterns - Unit, integration, and E2E testing

Operations & Maintenance

• CI/CD Guide - Build, test, and deployment processes
• Architecture Health - Quality monitoring and metrics

Reference Documentation

• File Structure Reference - Complete codebase navigation

Specialized Topics

• Scripts Reference - Complete npm scripts documentation
• Accessibility - Accessibility patterns and mobile optimization
• Client-Server Architecture - Server communication patterns

🎯 Finding the Right Document

By Task Type

Task	Primary Document	Supporting Documents
Learning to use MindMeld	User Guide	-
Setting up for development	Developer Guide	Scripts Reference
Understanding architecture	Developer Guide	Adapter-Behavior Pattern
Writing tests	Testing Patterns	-
Mobile/touch features	User Guide (users) Mobile Architecture (devs)	Accessibility
Git workflow issues	Git Workflow	-
CI/CD configuration	CI/CD Guide	Scripts Reference
Code standards	Coding Standards	Git Workflow

By Audience

End Users: User Guide covers everything needed New Developers: Developer Guide → Architecture docs → Development practices Experienced Contributors: Testing Patterns + specific technical docs as needed DevOps/Maintainers: Operations guides + Architecture Health

📖 Documentation Structure

Architecture Documentation (docs/architecture/)

Comprehensive system design and technical implementation details:

• System overview and principles
• Component interaction patterns
• Security architecture
• Mobile and touch systems
• Data management patterns

Development Documentation (docs/development/)

Practical development practices and workflows:

• Code standards and style guides
• Git workflow and versioning
• Testing strategies and patterns
• Debugging and troubleshooting

Operations Documentation (docs/operations/)

Deployment, monitoring, and maintenance:

• CI/CD pipelines
• Quality monitoring
• Version management
• Performance optimization

Reference Documentation (docs/reference/)

Detailed reference material:

• Complete file structure navigation
• Service layer documentation
• API and event system references

🔗 Cross-References

Documents are extensively cross-linked to provide context and related information:

• Bidirectional linking between related concepts
• File location references with specific line numbers where relevant
• Implementation examples with concrete code samples
• Related documentation sections in each file

📏 Documentation Standards

All documentation follows these principles for optimal consumption:

• 200-400 lines per file for focused content
• Context sections explaining how each document fits in the system
• Code examples with file locations and implementation details
• Cross-references with clear linking between related concepts
• LLM-optimized structure for AI-assisted development

🆕 Recent Improvements

January 2025 Restructure

• ✅ Modular documentation - Focused files replace monolithic guides
• ✅ Clear navigation - Logical organization by audience and purpose
• ✅ Eliminated duplication - Single source of truth for each topic
• ✅ Cross-platform coverage - Mobile and desktop development patterns
• ✅ LLM optimization - Structured for AI-assisted development workflows

This index provides comprehensive coverage of MindMeld's architecture and development practices, designed for both human developers and LLM-assisted development workflows.