Documentation Index

Local Development with Jekyll

This documentation can be built and served locally using Jekyll for better navigation and formatting.

Prerequisites

  • Ruby 3.0+ (install via Homebrew: brew install ruby)
  • Bundler gem

Quick Start

# From the docs directory
./serve.sh

This will install dependencies and start a local server at http://localhost:4000/docs

Manual Setup

cd docs
bundle install
bundle exec jekyll serve --livereload

Building for Production

bundle exec jekyll build

The built site will be in _site/ directory.

GitHub Pages Deployment

Documentation is automatically built and deployed to GitHub Pages when changes are pushed to the prod branch. The workflow is defined in .github/workflows/docs-jekyll.yml.

Welcome to the Aitana Labs Frontend documentation. This directory contains all technical documentation organized by category.

🤖 Request Documentation with Claude

Need help with Aitana or want to request new documentation? You can create a GitHub issue and our AI assistant will help you directly.

How to request documentation:

  1. Create a new GitHub issue on this repository
  2. Describe what documentation you’d like added or improved
  3. Mention @claude in your issue description
  4. Claude will analyze the request and create the documentation for you

Example:

Hi @claude, can you add documentation explaining how to configure 
custom Firebase rules for this project?

Claude can help with:

  • Creating new feature documentation
  • Updating existing guides
  • Adding troubleshooting sections
  • Writing API documentation
  • Creating development setup guides

Quick Links:

📁 Directory Structure

🛠️ Development

  • AITANA_CLI_API_COMMANDS.md - 🚀 Direct API access via Aitana CLI for models, tools, and comprehensive testing
  • CROSS_PLATFORM_SETUP.md - 💻 Cross-platform setup guide: Windows, macOS, Linux compatibility with aitana CLI server management
  • CI_CD_WORKFLOW.md - 🚀 Complete CI/CD workflow: dev → test → prod deployment strategy with automated testing and manual approval gates
  • BRANCH_STRATEGY.md - 🌳 Git branching strategy: three-branch deployment model with environment-specific protection rules
  • DEVELOPER_CONTRIBUTION_GUIDE.md - 👥 Complete guide for contributing: setup, development workflow, testing, and deployment process
  • DEPLOYMENT_PIPELINE.md - ⚙️ Technical deployment pipeline details: Cloud Build, multi-container Cloud Run, and parallel testing
  • ARTIFACT_CONTEXT.md - 🎨 Complete artifact management system for AI-generated content with localStorage persistence and real-time updates
  • ASSISTANT_CALLING_AGENT.md - 🤖 Intelligent agent for cross-assistant communication with parallel/sequential execution and context sharing
  • VAC_SERVICE_ARCHITECTURE.md - 🏗️ Complete VAC service architecture guide: three-phase processing, tool orchestration, and streaming
  • ASSISTANT_SSE_STREAMING.md - 🔄 NEW Production SSE streaming endpoint with thinking content preservation
  • BACKEND_API_HOWTO.md - Comprehensive backend API guide with authentication, models, and chat history
  • BACKEND_API_HOWTO_WINDOWS.md - Windows-specific backend API setup guide
  • BACKEND_MCP_INTEGRATION.md - 🔌 NEW Technical MCP architecture: client detection, stdio compatibility, tool registry
  • BACKEND_FASTAPI_MIGRATION.md - 🚀 NEW FastAPI migration guide: parallel implementation, performance improvements, deployment strategy
  • DEPRECATED_FEATURES.md - ⚠️ NEW Deprecated features and migration guide: what we don’t do anymore and what to use instead
  • BUILD_ERROR_DETECTION.md - 🤖 Automated build error detection system with smart false positive filtering
  • CODE_EXECUTION_AGENT.md - 🤖 AI-powered code generation system with test-driven development and iterative improvement
  • LOCAL_CI_CONSISTENCY.md - Essential guide for ensuring tests pass locally AND in CI
  • LOCAL_CI_SETUP.md - Local development environment setup for CI consistency
  • DOCKER_CONSISTENCY.md - Guide for matching local development with Docker build environment
  • COVERAGE_BADGE_SETUP.md - Setup coverage badges for GitHub using Cloud Build (backend)
  • FRONTEND_COVERAGE_SETUP.md - Frontend test coverage configuration and badge generation
  • STREAMING_CONTEXT.md - 🚀 Real-time streaming communication system for AI assistants with Firebase persistence and advanced session management
  • BACKEND_EMAIL_API.md - 📧 Technical API documentation for email integration system with webhook processing, rate limiting, and document exports
  • BACKEND_UTILITY_FUNCTIONS.md - 🛠️ Core backend utility functions for AI processing, content formatting, and system integration
  • BACKEND_TOOL_SYSTEM.md - ⚙️ Backend tool creation and prompt management system with Langfuse integration and dynamic tool configuration
  • CONTEXT_TIMEOUTS.md - ⏰ Detailed guide on context-based timeout system (UI: 60s, API: 5min) with implementation and troubleshooting
  • TIMEOUT_CONFIGURATION.md - ⏱️ Context-aware timeout configuration system for optimal performance across UI and background operations
  • API_TIMEOUT_PARAMETERS.md - 📋 Complete API timeout parameter reference with context-aware defaults and configuration options
  • api-call-example.md - Example API call patterns and usage
  • PROMPT_OPTIMIZATION.md - 🎯 Automated prompt optimization system using LLM evaluation and iterative improvement
  • PERFORMANCE_CONSIDERATIONS.md - ⚡ Performance optimization guidelines for time-sensitive operations and latency reduction

✨ Features

🧪 Testing

🔧 Troubleshooting

🖼️ Images

Screenshots and diagrams used in documentation

🚀 Quick Links

For Developers

🚀 Getting Started (Start Here)

🏗️ Architecture & APIs

🛠️ Development & Testing

⚙️ Advanced Features

For Users

For Administrators

For Debugging

📝 Documentation Standards

When adding new documentation:

  1. Place files in the appropriate category folder
  2. Use descriptive filenames in CAPS_WITH_UNDERSCORES.md format
  3. Update this index file with a brief description
  4. Include a clear title and purpose at the top of each document

🔍 Finding Information

📚 Other Important Files

These files remain in the project root for standard conventions:

  • ../README.md - Main project README
  • ../CLAUDE.md - AI assistance instructions
  • ../LICENSE.txt - Project license