Skip to main content

Monolex Documentation Structure Proposal

Source Analysis: /monolex/.claude/skills/monolex-architect/docs/

Main Chapters (18 files)

ChapterTitleCategory
ch1PTY Daemon & Session ArchitectureArchitecture
ch2AlacrittyRenderer - VTE Parsing & Grid UpdatesTerminal Core
ch3PTY Log - Terminal Activity LoggerFeatures
ch4Atomic Term IME - macOS Input Source DetectionInput
ch5NIIA Watcher - File System Monitoring DaemonDaemons
ch6Variable MD - Multi-Format Document ViewerFeatures
ch7Database ArchitectureDatabase
ch8Complex Relations - Component-Database IntegrationDatabase
ch9File-to-Database MappingDatabase
ch10Work Wiki Diff SystemFeatures
ch11Module → DB GraphDatabase
ch12Unified Module-DB Connection MapDatabase
ch13Terminal Scrollbar - Dual Mode ArchitectureUI
ch14Alacritty Parser Backup - IME Inverse Cursor SystemInput
ch15Grid Mode v2 - 5-Tier ArchitectureArchitecture
ch16Alacritty-xterm-Monolex Technology IntegrationArchitecture
ch17Dirty Tracking Implementation (Grid Mode v2.1)Performance
ch18PTY Daemon Ring Buffer ArchitectureArchitecture

Database Documentation (5 files)

FilePurpose
db-session.mdSession state persistence
db-onit.mdOnIt project tracking
db-niia-watcher.mdFile watcher events
db-work-wiki-diff.mdWork wiki diff storage
db-atomic-term.mdAtomic terminal data

Deep Dive Series

multi-tab-rendering/ (34 chapters)

Comprehensive terminal rendering analysis comparing Alacritty, Ghostty, and Monolex:
  • Architecture & Data Integrity (1-8)
  • VTE Parser & ANSI Escape (9-12)
  • Grid & Scrollback (13-16)
  • Rendering Pipeline (17-19)
  • Input & IME (20-23)
  • Font & GPU (24-26)
  • Window/Tab Management (27-28)
  • Configuration & Performance (29-30)
  • Tauri & Actor Patterns (31-34)

terminal-internals-deep-dive/ (30 chapters)

Technical deep dives on terminal internals:
  • Backpressure & Architecture (1-7)
  • Color, Cursor, Modes (8-12)
  • Protocols & Selection (13-16)
  • Rendering Pipelines (17-19)
  • Input Integration (20-22)
  • Font & GPU (23-25)
  • System Integration (26-30)

ux-ai-native-terminal/

Research on AI-native terminal UX:
  • 50-Step Analysis across 5 threads
  • BSU/ESU comparison
  • Selection mechanisms
  • Parser-grid interfaces
  • Terminal comparisons (Alacritty, Ghostty, WezTerm, xterm.js)

Proposed Mintlify Navigation Structure

{
  "navigation": {
    "groups": [
      {
        "group": "Get Started",
        "pages": [
          "introduction",
          "quickstart",
          "installation"
        ]
      },
      {
        "group": "Architecture",
        "pages": [
          "architecture/overview",
          "architecture/tauri-stack",
          "architecture/session-actor",
          "architecture/5-tier-grid-mode"
        ]
      },
      {
        "group": "Terminal Core",
        "pages": [
          "terminal/pty-daemon",
          "terminal/alacritty-renderer",
          "terminal/vte-parsing",
          "terminal/grid-system",
          "terminal/cell-converter"
        ]
      },
      {
        "group": "Input & Output",
        "pages": [
          "io/ime-integration",
          "io/keyboard-handling",
          "io/scrollbar",
          "io/dirty-tracking"
        ]
      },
      {
        "group": "Daemons",
        "pages": [
          "daemons/pty-daemon",
          "daemons/niia-watcher",
          "daemons/niia-mcp"
        ]
      },
      {
        "group": "Database",
        "pages": [
          "database/overview",
          "database/session-db",
          "database/onit-db",
          "database/watcher-db"
        ]
      },
      {
        "group": "Features",
        "pages": [
          "features/variable-md-viewer",
          "features/pty-logging",
          "features/work-wiki-diff"
        ]
      },
      {
        "group": "Deep Dives",
        "pages": [
          {
            "group": "Multi-Tab Rendering",
            "pages": [
              "deep-dives/multi-tab/architecture",
              "deep-dives/multi-tab/vte-parser",
              "deep-dives/multi-tab/rendering-pipeline",
              "deep-dives/multi-tab/comparison"
            ]
          },
          {
            "group": "Terminal Internals",
            "pages": [
              "deep-dives/internals/backpressure",
              "deep-dives/internals/ansi-sequences",
              "deep-dives/internals/grid-cells",
              "deep-dives/internals/gpu-rendering"
            ]
          }
        ]
      },
      {
        "group": "Research",
        "pages": [
          "research/ai-native-terminal-ux",
          "research/ack-flow-control",
          "research/terminal-comparison"
        ]
      }
    ]
  }
}

Implementation Priority

Phase 1: Core Documentation

  1. introduction.mdx - What is Monolex
  2. quickstart.mdx - Get running in 5 minutes
  3. installation.mdx - Download & setup
  4. architecture/overview.mdx - High-level architecture diagram

Phase 2: Architecture Deep Dive

  1. architecture/tauri-stack.mdx - Tauri + Rust + TypeScript
  2. architecture/session-actor.mdx - Lock-free concurrency
  3. architecture/5-tier-grid-mode.mdx - Grid Mode v2

Phase 3: Terminal Essentials

  1. terminal/pty-daemon.mdx - Daemon architecture
  2. terminal/alacritty-renderer.mdx - VTE parsing
  3. terminal/grid-system.mdx - Grid & buffer

Phase 4: Complete Documentation

  • Remaining sections based on user demand

Key Stats

CategoryFilesPriority
Main Chapters18High
Database Docs5Medium
Multi-Tab Rendering34Low (Advanced)
Terminal Internals30Low (Advanced)
AI-Native Research12+Medium
Total Source Files: 100+ Recommended Initial Pages: 10-15 Full Documentation: 50+ pages

Notes

  1. Korean → English: All source docs are in Korean. Translation needed for public docs.
  2. ASCII Diagrams: Keep the excellent ASCII architecture diagrams.
  3. Code Examples: Include Rust + TypeScript examples.
  4. Mintlify Components: Use <CodeGroup>, <Tabs>, <Card> for better UX.