VDK Docs

VDK Architecture & Visual Mappings

Comprehensive visual architecture diagrams and integration mappings for the VDK ecosystem

VDK Architecture & Visual Mappings

This document provides detailed visual mappings of the VDK ecosystem architecture, component interactions, and integration patterns.

System Architecture Overview

graph TB
    subgraph "Tier 1: VDK CLI (Local Engine)"
        CLI[VDK CLI v2.0.1]
        CLI_Scanner[Project Scanner<br/>- File traversal<br/>- Technology detection<br/>- Pattern analysis]
        CLI_TechAnalyzer[Technology Analyzer<br/>- Framework detection<br/>- Dependencies analysis<br/>- Build tools identification]
        CLI_PatternDetector[Pattern Detector<br/>- Naming conventions<br/>- Code patterns<br/>- Architecture detection]
        CLI_RuleGenerator[Rule Generator<br/>- Remote blueprint fetching<br/>- Light templating<br/>- Platform adaptation]
        CLI_IntegrationManager[Integration Manager<br/>- Multi-IDE support<br/>- Config generation<br/>- File deployment]
        
        CLI --> CLI_Scanner
        CLI --> CLI_TechAnalyzer
        CLI --> CLI_PatternDetector
        CLI --> CLI_RuleGenerator
        CLI --> CLI_IntegrationManager
    end
    
    subgraph "Tier 2: VDK Blueprints Repository (Knowledge Base)"
        BlueprintsRepo[VDK Blueprints Repository<br/>GitHub: entro314-labs/VDK-Blueprints]
        
        subgraph "Blueprint Categories"
            Core[Core Rules (4)<br/>- Agent behavior<br/>- Code quality<br/>- Security practices<br/>- Error prevention]
            Languages[Languages (6)<br/>- TypeScript<br/>- Python<br/>- Swift<br/>- C++20<br/>- Go<br/>- Rust]
            Technologies[Technologies (26)<br/>- React 19<br/>- Next.js 15<br/>- Vue 3<br/>- Supabase<br/>- Tailwind CSS 4]
            Stacks[Stacks (6)<br/>- Next.js + Supabase<br/>- React Native<br/>- MEAN Stack<br/>- Django + PostgreSQL]
            Tasks[Tasks (54)<br/>- AI Code Review<br/>- Security Audit<br/>- API Design<br/>- Testing Strategy]
            Assistants[Assistants (7)<br/>- Claude Code<br/>- Cursor<br/>- Windsurf<br/>- GitHub Copilot]
            Tools[Tools (3)<br/>- File operations<br/>- Command execution<br/>- Version control]
        end
        
        BlueprintsRepo --> Core
        BlueprintsRepo --> Languages
        BlueprintsRepo --> Technologies
        BlueprintsRepo --> Stacks
        BlueprintsRepo --> Tasks
        BlueprintsRepo --> Assistants
        BlueprintsRepo --> Tools
    end
    
    subgraph "Tier 3: VDK Hub (Web Platform)"
        Hub[VDK Hub<br/>Next.js 15 + React 19 + Supabase]
        Hub_Catalog[Blueprint Catalog<br/>- Browse 108+ blueprints<br/>- Advanced search & filtering<br/>- Preview & compatibility]
        Hub_Generator[Blueprint Generator<br/>- 7-step wizard<br/>- Custom package creation<br/>- Platform-specific output]
        Hub_Collections[User Collections<br/>- Personal libraries<br/>- Team sharing<br/>- Public collections]
        Hub_Admin[Admin Dashboard<br/>- Platform management<br/>- Sync monitoring<br/>- Analytics tracking]
        
        Hub --> Hub_Catalog
        Hub --> Hub_Generator
        Hub --> Hub_Collections
        Hub --> Hub_Admin
    end
    
    CLI_RuleGenerator -.->|Fetches from| BlueprintsRepo
    Hub_Catalog -.->|Syncs with| BlueprintsRepo
    Hub_Generator -.->|Creates packages for| CLI
    
    subgraph "AI Assistant Integrations"
        Claude[Claude Code<br/>.claude/CLAUDE.md]
        Cursor[Cursor<br/>.cursor/rules/*.mdc]
        Windsurf[Windsurf<br/>.windsurf/rules/*.xml]
        Copilot[GitHub Copilot<br/>.github/copilot/guidelines.json]
    end
    
    CLI_IntegrationManager --> Claude
    CLI_IntegrationManager --> Cursor
    CLI_IntegrationManager --> Windsurf
    CLI_IntegrationManager --> Copilot

CLI Data Flow Architecture

graph TD
    A[Developer Runs: vdk init] --> B[Project Scanner]
    B --> C{File System Analysis}
    C --> D[package.json Detection]
    C --> E[Config Files Detection]
    C --> F[Source Code Analysis]
    C --> G[Directory Structure Mapping]
    
    D --> H[Technology Analyzer]
    E --> H
    F --> H
    G --> H
    
    H --> I[Pattern Detector]
    I --> J{Architecture Pattern Recognition}
    J --> K[Naming Convention Detection]
    J --> L[Framework Pattern Analysis]
    J --> M[Code Style Analysis]
    
    K --> N[Rule Generator]
    L --> N
    M --> N
    
    N --> O{Blueprint Repository Fetch}
    O -->|Success| P[Remote Blueprint Processing]
    O -->|Failure| Q[Fallback Local Rules]
    
    P --> R[Template Processing]
    Q --> R
    
    R --> S[Platform Adaptation]
    S --> T{Target Platform Selection}
    T --> U[Claude Code Config]
    T --> V[Cursor Rules]
    T --> W[Windsurf Memory]
    T --> X[Copilot Guidelines]
    
    U --> Y[Integration Manager]
    V --> Y
    W --> Y
    X --> Y
    
    Y --> Z[File Deployment]
    Z --> AA[Configuration Validation]
    AA --> BB[Success Report]

Blueprint Repository Structure

graph TB
    subgraph "VDK-Blueprints Repository"
        Root[Repository Root<br/>entro314-labs/VDK-Blueprints]
        
        subgraph "Core Structure"
            Schema[Schema<br/>blueprint-schema.json<br/>v2.1.0]
            Readme[README.md<br/>Repository documentation]
            License[LICENSE<br/>MIT License]
            Contrib[CONTRIBUTING.md<br/>Contribution guidelines]
        end
        
        subgraph "Blueprint Categories"
            CoreDir[core/<br/>4 blueprints<br/>- agent-behavior.md<br/>- code-quality.md<br/>- security.md<br/>- error-prevention.md]
            
            LangDir[languages/<br/>6 blueprints<br/>- typescript.md<br/>- python.md<br/>- swift.md<br/>- cpp20.md<br/>- go.md<br/>- rust.md]
            
            TechDir[technologies/<br/>26 blueprints<br/>- react-19.md<br/>- nextjs-15.md<br/>- vue-3.md<br/>- supabase.md<br/>- tailwind-4.md]
            
            StackDir[stacks/<br/>6 blueprints<br/>- nextjs-supabase.md<br/>- react-native.md<br/>- mean-stack.md<br/>- django-postgresql.md]
            
            TaskDir[tasks/<br/>54 blueprints<br/>- ai-code-review.md<br/>- security-audit.md<br/>- api-design.md<br/>- testing-strategy.md]
            
            AssistDir[assistants/<br/>7 blueprints<br/>- claude-code.md<br/>- cursor.md<br/>- windsurf.md<br/>- copilot.md]
            
            ToolDir[tools/<br/>3 blueprints<br/>- file-operations.md<br/>- command-execution.md<br/>- version-control.md]
        end
        
        Root --> Schema
        Root --> Readme
        Root --> License
        Root --> Contrib
        Root --> CoreDir
        Root --> LangDir
        Root --> TechDir
        Root --> StackDir
        Root --> TaskDir
        Root --> AssistDir
        Root --> ToolDir
    end

VDK Hub Application Architecture

graph TB
    subgraph "Frontend Layer (Next.js 15 + React 19)"
        UI[User Interface<br/>React Server Components]
        Pages[App Router Pages<br/>- /catalog<br/>- /generator<br/>- /collections<br/>- /admin]
        Components[UI Components<br/>- BlueprintCard<br/>- SearchFilters<br/>- GeneratorWizard<br/>- CollectionManager]
        
        UI --> Pages
        UI --> Components
    end
    
    subgraph "API Layer (Next.js API Routes)"
        API[API Routes<br/>/api/...]
        Blueprints[/api/blueprints<br/>CRUD operations]
        Collections[/api/collections<br/>User collections]
        Generator[/api/generator<br/>Package creation]
        Sync[/api/sync<br/>Repository sync]
        
        API --> Blueprints
        API --> Collections
        API --> Generator
        API --> Sync
    end
    
    subgraph "Database Layer (Supabase)"
        DB[(Supabase PostgreSQL)]
        Tables{Database Tables}
        Tables --> UsersTable[users<br/>User accounts]
        Tables --> BlueprintsTable[blueprints<br/>Blueprint metadata]
        Tables --> CollectionsTable[collections<br/>User collections]
        Tables --> AnalyticsTable[analytics<br/>Usage tracking]
        
        RLS[Row Level Security<br/>User data isolation]
        Subscriptions[Real-time Subscriptions<br/>Live updates]
        
        DB --> Tables
        DB --> RLS
        DB --> Subscriptions
    end
    
    subgraph "External Integrations"
        GitHub[GitHub API<br/>Repository access]
        Webhooks[GitHub Webhooks<br/>Change notifications]
        CDN[Vercel CDN<br/>Global distribution]
        Analytics[Analytics Tracking<br/>Usage metrics]
    end
    
    Pages --> API
    API --> DB
    Sync --> GitHub
    GitHub --> Webhooks
    UI --> CDN
    Components --> Analytics

AI Assistant Integration Patterns

graph LR
    subgraph "VDK CLI Output"
        CLI[VDK CLI<br/>Analysis Results]
        TechStack[Detected Tech Stack<br/>React + TypeScript + Supabase]
        Patterns[Detected Patterns<br/>Functional components<br/>Custom hooks<br/>Server actions]
    end
    
    subgraph "Platform Adapters"
        ClaudeAdapter[Claude Adapter<br/>.claude/ format]
        CursorAdapter[Cursor Adapter<br/>.cursor/rules/ format]
        WindsurfAdapter[Windsurf Adapter<br/>.windsurf/rules/ format]
        CopilotAdapter[Copilot Adapter<br/>.github/copilot/ format]
    end
    
    subgraph "Generated Configurations"
        ClaudeConfig[.claude/CLAUDE.md<br/>Memory-based context<br/>Project overview<br/>Tech stack details<br/>Coding patterns]
        
        CursorConfig[.cursor/rules/*.mdc<br/>YAML frontmatter<br/>File pattern matching<br/>Auto-completion rules]
        
        WindsurfConfig[.windsurf/rules/*.xml<br/>XML memory format<br/>Workspace awareness<br/>6K character limit]
        
        CopilotConfig[.github/copilot/guidelines.json<br/>JSON configuration<br/>Repository settings<br/>Review integration]
    end
    
    CLI --> TechStack
    CLI --> Patterns
    
    TechStack --> ClaudeAdapter
    TechStack --> CursorAdapter
    TechStack --> WindsurfAdapter
    TechStack --> CopilotAdapter
    
    Patterns --> ClaudeAdapter
    Patterns --> CursorAdapter
    Patterns --> WindsurfAdapter
    Patterns --> CopilotAdapter
    
    ClaudeAdapter --> ClaudeConfig
    CursorAdapter --> CursorConfig
    WindsurfAdapter --> WindsurfConfig
    CopilotAdapter --> CopilotConfig

Blueprint Processing Pipeline

graph TD
    A[Blueprint Request] --> B{Source Check}
    B -->|Remote| C[GitHub API Fetch]
    B -->|Local| D[Local Blueprint Cache]
    
    C --> E[Content Validation]
    D --> E
    
    E --> F{Schema Valid?}
    F -->|No| G[Error: Invalid Blueprint]
    F -->|Yes| H[Metadata Extraction]
    
    H --> I[Compatibility Check]
    I --> J{Platform Compatible?}
    J -->|No| K[Skip Blueprint]
    J -->|Yes| L[Template Processing]
    
    L --> M[Variable Substitution]
    M --> N{Variables Present?}
    N -->|Yes| O[Project Context Injection]
    N -->|No| P[Direct Content Use]
    
    O --> Q[Platform Adaptation]
    P --> Q
    
    Q --> R{Target Platform}
    R --> S[Claude Format]
    R --> T[Cursor Format]
    R --> U[Windsurf Format]
    R --> V[Copilot Format]
    
    S --> W[Content Optimization]
    T --> W
    U --> W
    V --> W
    
    W --> X[File Generation]
    X --> Y[Deployment]

Real-time Synchronization Flow

sequenceDiagram
    participant Dev as Developer
    participant CLI as VDK CLI
    participant Hub as VDK Hub
    participant Repo as Blueprint Repository
    participant DB as Supabase DB
    participant AI as AI Assistant

    Note over Repo: Blueprint updated in repository
    Repo->>Hub: GitHub Webhook notification
    Hub->>DB: Update blueprint metadata
    DB->>Hub: Real-time subscription update
    Hub->>Dev: Browser notification (if online)
    
    Dev->>CLI: vdk update
    CLI->>Repo: Fetch latest blueprints
    Repo-->>CLI: Return updated content
    CLI->>CLI: Generate new configurations
    CLI->>AI: Deploy updated configs
    AI-->>Dev: Enhanced context awareness
    
    Note over Dev, AI: Seamless update without interruption

Security Architecture

graph TB
    subgraph "Client Security"
        LocalAnalysis[Local Project Analysis<br/>No code uploaded]
        AnonymousAccess[Anonymous CLI Usage<br/>No authentication required]
        CacheEncryption[Local Cache Encryption<br/>Sensitive data protection]
    end
    
    subgraph "Hub Security"
        OAuth[OAuth Authentication<br/>GitHub integration]
        RLS[Row Level Security<br/>User data isolation]
        RateLimit[API Rate Limiting<br/>Abuse prevention]
        InputValidation[Input Validation<br/>XSS/injection prevention]
    end
    
    subgraph "Repository Security"
        TokenAuth[GitHub Token Auth<br/>Repository access control]
        WebhookVerification[Webhook Signature Verification<br/>Authentic updates only]
        ContentValidation[Content Schema Validation<br/>Blueprint integrity]
        VersionControl[Full Version Control<br/>Change tracking & rollback]
    end
    
    subgraph "Data Protection"
        Anonymization[Analytics Anonymization<br/>90-day data retention]
        NoCodeSharing[No Code Sharing<br/>Project content stays local]
        EncryptedTransit[HTTPS/TLS Encryption<br/>Data in transit protection]
        SecureStorage[Encrypted Storage<br/>Sensitive data at rest]
    end
    
    LocalAnalysis --> Hub
    AnonymousAccess --> Hub
    CacheEncryption --> Hub
    
    OAuth --> Repository
    RLS --> Repository
    RateLimit --> Repository
    InputValidation --> Repository
    
    TokenAuth --> Data
    WebhookVerification --> Data
    ContentValidation --> Data
    VersionControl --> Data

Performance Optimization Strategies

graph TB
    subgraph "CLI Performance"
        FileSystem[File System Optimization<br/>- Parallel scanning<br/>- .gitignore respect<br/>- Intelligent caching]
        
        Network[Network Optimization<br/>- Blueprint caching<br/>- Conditional requests<br/>- Compression]
        
        Processing[Processing Optimization<br/>- Lazy loading<br/>- Incremental analysis<br/>- Worker threads]
    end
    
    subgraph "Hub Performance"
        Frontend[Frontend Optimization<br/>- Server components<br/>- Static generation<br/>- Edge caching]
        
        Database[Database Optimization<br/>- Query optimization<br/>- Connection pooling<br/>- Real-time subscriptions]
        
        CDN[CDN Optimization<br/>- Global distribution<br/>- Asset optimization<br/>- Smart caching]
    end
    
    subgraph "Repository Performance"
        GitHub[GitHub Optimization<br/>- API rate management<br/>- Webhook efficiency<br/>- Content delivery]
        
        Caching[Caching Strategy<br/>- Multi-level caching<br/>- Invalidation logic<br/>- Compression]
        
        ContentOpt[Content Optimization<br/>- File size limits<br/>- Format efficiency<br/>- Batch operations]
    end
    
    FileSystem --> Frontend
    Network --> Database
    Processing --> CDN
    
    Frontend --> GitHub
    Database --> Caching
    CDN --> ContentOpt

This comprehensive visual architecture documentation provides detailed insight into the VDK ecosystem's design, implementation, and operational patterns. Each diagram illustrates specific aspects of the system's functionality and can be used for technical planning, troubleshooting, and system understanding.