Skip to main content

📚 AZ1.AI llm IDE - Documentation Index

Quick Navigation: Find all project documentation organized by category

🚀 Getting Started​

For New Contributors​

  1. README.md - Project overview & quick start
  2. CLAUDE.md - AI assistant guidance & context
  3. Quick Start Guide - 5-minute setup
  4. Project Plan - 15 phases, 300+ tasks

For Continuing Work​

  1. Latest Session - Previous context
  2. Session Context - Summary
  3. Project Status - Current state
  4. Next Steps - What's next

📖 Core Documentation​

Design Documents​

Architecture Decision Records (ADRs)​

14 ADRs documenting key architectural decisions

Foundation:

State & Data:

UI Components:

llm & Agents:

Build:

📁 Documentation by Category​

🏗️ Architecture​

📘 User Guides​

📊 Status & Progress​

🔨 Build & Migration Logs​

🔄 Session Management​

📋 Project Planning​

🔌 API Documentation​

🎯 Quick Links by Role​

For AI Agents (Claude Code, LM Studio, etc.)​

Start here every session:

  1. ✅ CLAUDE.md - Complete guidance for AI assistants
  2. ✅ Latest Session Context
  3. ✅ Project Plan
  4. ✅ ADR-014: theia Foundation

For Developers​

Implementation guides:

  1. Quick Start - Setup environment
  2. TDD - Technical implementation details
  3. theia Extension Guide - Build extensions
  4. Source Code - Browse implementation

For Architects​

Design decisions:

  1. SDD - System design
  2. Architecture - High-level overview
  3. All ADRs - Decision records
  4. Diagrams - Visual architecture

For Project Managers​

Planning & tracking:

  1. Project Plan - All tasks
  2. Status Report - Current status
  3. Session History - Progress log
  4. README - Project overview

📈 Project Progress​

Completion Status: ~22% (67/300+ tasks)

✅ Completed Phases​

  • Phase 1: Foundation Setup (100%)
  • Phase 2: Core Infrastructure (100%)
  • Phase 3: theia llm Extension (100%)

🔲 Upcoming Phases​

  • Phase 4: Session Management Extension
  • Phase 5: MCP Integration Extension
  • Phase 6: Agent System Extension

See: Project Plan for details

🔍 How to Find Documentation​

By Topic​

  • Architecture: docs/architecture/, docs/adr/
  • User Guides: docs/guides/
  • API: docs/api/
  • Status: docs/status-reports/
  • Build Logs: docs/build-logs/

By File Type​

  • Markdown Docs: docs/**/*.md
  • Diagrams: docs/diagrams/*.mmd
  • Session Exports: sessions/**/*
  • Project Plans: project-tasks/**/*
# Find all documentation about theia
grep -r "theia" docs/

# Find session context
ls -la sessions/*/session-context.md

# Find ADRs
ls docs/adr/

🆕 Adding New Documentation​

Creating a New Guide​

# 1. Create file in appropriate folder
touch docs/guides/my-new-guide.md

# 2. Use this template:
cat > docs/guides/my-new-guide.md << 'EOF'
# Guide Title

## Overview
[Brief description]

## Prerequisites
[What's needed]

## Steps
1. [Step 1]
2. [Step 2]

## Troubleshooting
[Common issues]
EOF

# 3. Add to this index.md
# 4. Commit to git

Creating a New ADR​

See: ADR Template (if exists) or copy existing ADR structure

Exporting a Session​

See: Session Guide

📝 Documentation Standards​

File Naming​

  • Use kebab-case: my-file-name.md
  • Be descriptive: theia-llm-extension.md not ext.md
  • Date sessions: 2025-10-06_topic-name/

Markdown Style​

  • Use headers hierarchically (H1 → H2 → H3)
  • Include table of contents for long docs
  • Use code blocks with language specification
  • Add emojis for visual navigation 📚 🚀 ✅

Organization​

  • Keep related docs together
  • Use subfolders for categories
  • Link between related docs
  • Update index.md when adding files

Last Updated: 2025-10-06 Maintained By: AZ1.AI Development Team