Skip to content

Latest commit

 

History

History
88 lines (64 loc) · 3.61 KB

File metadata and controls

88 lines (64 loc) · 3.61 KB

Document Analyzer - Documentation Hub

Welcome to the Document Analyzer Operator Platform documentation.

📚 Documentation Categories

🚀 Getting Started (6 guides)

Guide Description
Quick Start Quick reference card
Zero Config Setup Automated setup (no .env editing)
Native Setup Native setup without Docker
Windows Setup Windows PowerShell quick setup
Auto Setup Guide Automated setup walkthrough
Docker Setup Docker-based deployment

👤 User Guides (4 guides)

Guide Description
LLM Providers Complete LLM provider configuration
Settings Management UI-based settings management
OpenAI Compatible OpenAI-compatible providers (Groq, Together AI, etc.)
Running with Poetry Python dependency management

🏗️ Architecture (3 guides)

Guide Description
Architecture Complete system architecture
Agent Framework Agent framework documentation
Workflow Engine Workflow engine guide

📦 Implementation (5 guides)

Guide Description
Implementation Summary Complete implementation overview
LLM Implementation LLM integration details
Settings Implementation Settings system implementation
Auto Setup Summary Automated setup implementation
OpenAI Compatible Implementation OpenAI-compatible provider implementation

🔧 Technical Reference (3 guides)

Guide Description
API Reference API endpoint documentation
Tools and Knowledge Tools and knowledge infrastructure
Validation Report Code validation report

🔍 Troubleshooting (1 guide)

Guide Description
Troubleshooting Common issues and solutions

📖 Additional Documentation

🌐 Live Documentation

When the backend is running, visit:

📝 Documentation Guidelines

This documentation is organized by audience and purpose:

  • Getting Started: For new users setting up the platform
  • User Guides: For end-users configuring and using features
  • Architecture: For developers understanding system design
  • Implementation: For contributors implementing features
  • Technical Reference: For API consumers and integrators
  • Troubleshooting: For resolving common issues

Last Updated: March 2026 Version: 2.0.0