Skip to content

DOCUMENTATION-INDEX.md

Latest commit

 

History

History
149 lines (112 loc) · 5.31 KB

DOCUMENTATION-INDEX.md

File metadata and controls

149 lines (112 loc) · 5.31 KB

📚 MindRoots Documentation Index

Complete reference to all project documentation

🏠 Primary Documentation

CLAUDE.md 📖 Master Reference

Claude's comprehensive codebase guide - your go-to development companion

  • Complete architecture overview
  • File structure & key components
  • Root search system documentation
  • Database structure & relationships
  • API endpoints reference
  • Development workflows & patterns
  • Git deployment procedures
  • UI overhaul & validation system
  • Hierarchical ID compatibility fixes
  • Corpus item navigation system

README.md 🌟 Project Overview

Public-facing project description

  • Project purpose & scope
  • License information (CC BY-NC-SA 4.0)
  • High-level description

🔧 Feature Documentation

docs/features/VALIDATION-SYSTEM-DOCUMENTATION.md ✏️ Validation System

Comprehensive guide to the inline editing & approval system

  • User workflow & interaction patterns
  • Backend persistence & spam protection
  • Approval tracking & validation counters
  • API endpoints & testing procedures
  • Status: Production-ready

docs/features/RADICAL-SEARCH-INTEGRATION.md 🔍 RadicalPosition System

Integration guide for the flexible radical search architecture

  • RadicalPosition layer implementation
  • Backend endpoint templates
  • Neo4j query patterns
  • Migration from hardcoded r1/r2/r3 system
  • Status: Production-ready

docs/features/COLLAPSE-FUNCTIONALITY.md 🎯 Node Interactions

Documentation for expand/collapse behavior

  • Second-click collapse functionality
  • Root & form node interaction patterns
  • Graph & table mode compatibility
  • Date: August 21, 2025

docs/features/INFOBUBBLE-POSITIONING-GUIDE.md 💬 InfoBubble Positioning

Complete guide to fixing InfoBubble positioning across all components

  • Three positioning patterns: click-based, center-screen, context menu
  • Common issues & solutions (bottom-left positioning problem)
  • Production examples & implementation code
  • Best practices & troubleshooting guide
  • Date: September 16, 2025
  • Status: Production reference guide

docs/features/MOBILE-DEVELOPMENT-READINESS.md 📱 Mobile App Development

Comprehensive assessment for iOS/Android mobile app development

  • Complete codebase analysis (57 JS files, 38 components, 6,407 lines)
  • React Native vs PWA framework recommendations
  • D3.js mobile visualization strategy
  • 5-phase implementation roadmap (14-20 weeks)
  • Date: September 9, 2025
  • Status: Ready for framework selection and proof-of-concept

🧪 Development & Testing

docs/testing/BACKEND-TEST-RESULTS.md ✅ Test Verification

Comprehensive test results for backend improvements

  • All endpoint verification
  • Authentication testing
  • Feature functionality confirmation
  • Result: All tests passed

docs/testing/FRONTEND-INTEGRATION-CHECKLIST.md 📋 Integration Testing

Frontend integration checklist for backend changes

  • Testing procedures & verification steps
  • Backend compatibility confirmation
  • Ready-for-integration status
  • Date: August 21, 2025

📁 Archived Documentation

docs/archived/BACKEND-DEDUPLICATION-FIXES.md 🔧 Backend Fixes

Historical: Critical backend improvements & deduplication solutions

  • Duplicate node resolution
  • Info bubble improvements
  • Production-ready changes
  • Date: August 21, 2025
  • Status: Production-deployed, archived for reference

📁 Additional Resources

docs/development-prototypes/

🗂️ Documentation Categories

Architecture & System Design

  • CLAUDE.md - Complete system architecture
  • docs/features/RADICAL-SEARCH-INTEGRATION.md - Search system design

User Features

  • docs/features/VALIDATION-SYSTEM-DOCUMENTATION.md - Inline editing system
  • docs/features/COLLAPSE-FUNCTIONALITY.md - Node interaction patterns

Development & Testing

  • docs/testing/BACKEND-TEST-RESULTS.md - Test verification
  • docs/testing/FRONTEND-INTEGRATION-CHECKLIST.md - Integration procedures

Historical Reference

  • docs/archived/BACKEND-DEDUPLICATION-FIXES.md - Production fixes (archived)

Project Information

  • README.md - Project overview & licensing
  • DOCUMENTATION-INDEX.md - This index file

📌 Quick Navigation

Need to understand the codebase? → Start with CLAUDE.md

Implementing new features? → Check relevant feature documentation

Testing changes? → Use test results & checklists for reference

Deploying to production? → Follow deployment procedures in CLAUDE.md

Last Updated: September 7, 2025
All documentation is actively maintained and production-current