This document provides a central navigation point for all documentation in the NeuroCognitive Architecture (NCA) project.
- Project Overview (README.md) - Main project description and entry point
- Getting Started - Quick start guide for new users
- Configuration - Configuration options and settings
- Examples - Usage examples and patterns
- Advanced Usage - Advanced features and techniques
- Extensions - Building custom extensions
- Integration - Integrating with other systems
- Components - Core system components
- Data Flow - Information flow between components
- Architecture Decisions - Key architecture decisions
- Component Interactions - How memory components work together
- Backend Configuration - Configuring memory backends
- Directory Structure - Memory system codebase organization
- Deployment Guide - Deploying memory systems
- Refactoring - Memory system refactoring plans
- Test Plan - Testing the memory system
- Thread Safety Fixes - Thread safety improvements
- ADR-001: Memory Tiers - Memory tier architecture decisions
- ADR-002: Health System - Health system architecture decisions
- ADR-003: Integration Approach - Integration architecture decisions
- API Reference - Complete API reference
- Endpoints - REST API endpoints
- Schemas - API data schemas
- Examples - API usage examples
- Health System Overview - Introduction to the Health System
- Technical Benefits - Benefits of the Health System
- Implementation Guide - Implementing the Health System
- LangChain Overview - Introduction to LangChain integration
- Chains - Using LangChain chains
- Memory - LangChain memory components
- Tools - Using LangChain tools
- Contributing - How to contribute to NCA
- Environment Setup - Setting up development environment
- Coding Standards - NCA coding standards
- Development Workflow - Development process
- Deployment - Deployment instructions
- Monitoring - Monitoring the system
- Troubleshooting - Troubleshooting guide
- Backup & Restore - Backup and restoration procedures
- Incident Response - Handling incidents
- Scaling - Scaling the system
- Diagram Index - All architecture diagrams
- System Architecture - High-level system architecture
- Cognitive Control Overview - Cognitive control system overview
- Cognitive Control Index - Cognitive control diagrams
- Goals Component - Goal management system
- Inhibition Component - Inhibition system
- Metacognition Component - Metacognition system
- Planning Component - Planning system
- Memory System Overview - Memory system overview
- Memory System Index - Memory system diagrams
- Memory Tiers - Memory tier architecture
- Memory Backends - Storage backends
- Lymphatic System - Memory maintenance system
- Health System Overview - Health system overview
- Health System Index - Health system diagrams
- Monitoring Component - Health monitoring
- Dynamics Component - Health dynamics
- Registry Component - Component registry
- Integration Index - Integration diagrams
- LangChain Integration - LangChain integration
- LLM Integration - LLM integration
- API Integration - API integration
- Infrastructure Overview - Infrastructure architecture
- Data Flow Overview - Data flow architecture
- API Module - API implementation
- Assets Module - Static assets
- Config Module - Configuration system
- Core Module - Core domain logic
- Integration Module - External integrations
- Memory Module - Memory system
- Scripts Overview - Utility scripts
- Plutonium Tool - Project analysis tool
- Tests Overview - Testing documentation
- MkDocs Configuration - Documentation site configuration
- Docs Overview - Documentation organization
Note: For a browsable documentation site, run mkdocs serve in the Neuroca/docs directory.