Where to Find OmniRoute Documentation: Complete Guide to the docs/ Directory

OmniRoute’s complete documentation lives in the docs/ directory of the diegosouzapw/OmniRoute repository, with docs/README.md serving as the central navigation index for all guides, API references, and architecture specifications.

The diegosouzapw/OmniRoute repository maintains its OmniRoute documentation as version-controlled Markdown files alongside the source code. This structure ensures that every code change is accompanied by relevant documentation updates, and the same Markdown files power both the repository browser view and the live Documentation UI rendered within the application.

Main Entry Point: docs/README.md

All documentation navigation begins at docs/README.md, which functions as the master index linking to every major section. This file provides the pathways to implementation guides, architectural deep-dives, and operational checklists. Because the Documentation UI generates its content directly from these Markdown files, any updates committed to the repository are immediately reflected in the live help system.

Core Documentation Sections

The docs/ folder is organized into topical subdirectories that mirror the system's functional domains.

Getting-Started Guides

Located in docs/getting-started/, this section covers quick-start procedures, provider setup instructions, and free-tier usage policies. New users should begin here to configure their initial routing environment and understand basic credential management.

Architecture Overview

The file docs/architecture/ARCHITECTURE.md contains the high-level system diagram and request pipeline breakdown. This document explains how components interact during request processing and defines the fundamental data flow through the system.

Resilience Patterns

Detailed fault-tolerance mechanisms are documented in docs/architecture/RESILIENCE_GUIDE.md. This covers the circuit-breaker implementation, connection cooldown strategies, and model lockout procedures that ensure system stability during provider outages.

Auto-Combo Routing

The docs/routing/AUTO-COMBO.md file describes the intelligent scoring engine that manages 19 distinct routing strategies through virtual factories. Developers implementing custom routing logic should reference this document for strategy definitions and scoring algorithms.

API and Environment Reference

The docs/reference/ directory contains the complete OpenAI-compatible REST API surface in API_REFERENCE.md alongside ENVIRONMENT.md, which catalogs all environment variable definitions and their default values.

Security Guidelines

Located under docs/security/, this section includes mandatory patterns for error sanitization and public credential handling. The file docs/security/ERROR_SANITIZATION.md specifically defines requirements for scrubbing sensitive data from error responses.

Framework Integration

The docs/frameworks/ subdirectory covers advanced integration patterns including the Model Context Protocol server architecture (MCP-SERVER.md), A2A server configurations, cloud agent deployments, and embedded service implementations.

Operations and Deployment

System administrators should consult docs/ops/ for the RELEASE_CHECKLIST.md, tunnel configuration guides, Fly.io deployment procedures, and monitoring setup instructions.

Essential Reference Files for Developers

For direct implementation work, these specific files provide the authoritative technical specifications:

• docs/architecture/ARCHITECTURE.md – High-level system architecture and request pipeline visualization
• docs/architecture/RESILIENCE_GUIDE.md – Detailed resilience model including circuit breaker states and cooldown mechanics
• docs/routing/AUTO-COMBO.md – Auto-Combo scoring engine documentation, 19 strategy definitions, and virtual factory patterns
• docs/reference/API_REFERENCE.md – Complete OpenAI-compatible REST API endpoint specifications
• docs/reference/ENVIRONMENT.md – Exhaustive environment variable reference with default values
• docs/security/ERROR_SANITIZATION.md – Mandatory error response sanitization patterns
• docs/frameworks/MCP-SERVER.md – Model Context Protocol server tool set and architecture
• docs/ops/RELEASE_CHECKLIST.md – Quality-gate checklist and step-by-step release flow

Local Access and Navigation

Clone the repository and access documentation locally using standard command-line tools:

# Clone the repository

git clone https://github.com/diegosouzapw/OmniRoute.git
cd OmniRoute

# Open the main documentation index

open docs/README.md

View specific architectural documents directly from the terminal:

# Render the Architecture diagram in the terminal

npx markdown-cli docs/architecture/ARCHITECTURE.md | less

Retrieve the API specification for IDE integration or external tooling:

# Download the raw OpenAPI specification

curl -L https://raw.githubusercontent.com/diegosouzapw/OmniRoute/release/v3.8.51/docs/reference/openapi.yaml

Summary

• The OmniRoute documentation root is the docs/ directory in the diegosouzapw/OmniRoute repository.
• docs/README.md serves as the central navigation hub linking to all sections.
• Architecture details reside in docs/architecture/, including system diagrams in ARCHITECTURE.md and resilience patterns in RESILIENCE_GUIDE.md.
• Routing logic is documented in docs/routing/AUTO-COMBO.md with 19 documented strategies.
• API specifications and environment variables are cataloged under docs/reference/.
• Security requirements, including error sanitization, are defined in docs/security/.
• The Documentation UI renders directly from these Markdown files, ensuring live docs match the repository state.

Frequently Asked Questions

Where is the official OmniRoute documentation hosted?

The official documentation is hosted within the GitHub repository at https://github.com/diegosouzapw/OmniRoute/tree/release/v3.8.51/docs/. While the files are readable on GitHub, they also power the in-app Documentation UI, which renders the same Markdown content for integrated help.

Can I read the OmniRoute documentation without an internet connection?

Yes. Once you clone the repository with git clone https://github.com/diegosouzapw/OmniRoute.git, the entire docs/ directory is available locally. You can open docs/README.md in any Markdown viewer or text editor to browse all guides, API references, and architecture documents offline.

Which file contains the system architecture diagram for OmniRoute?

The high-level system architecture and request pipeline diagram are located in docs/architecture/ARCHITECTURE.md. This file provides the component breakdown and visual flow of how requests traverse the system from ingestion to provider dispatch.

How do I find the complete list of environment variables for OmniRoute configuration?

All environment variable definitions, defaults, and configuration options are documented in docs/reference/ENVIRONMENT.md. This reference file pairs with docs/reference/API_REFERENCE.md, which details the REST API surface, to provide complete configuration coverage for deployments.

{
  "mcpServers": {
    "instagit": {
      "command": "npx",
      "args": ["-y", "instagit@latest"]
    }
  }
}