Files
OmniRoute/docs
diegosouzapw e2858a8418 ci: derived-files guard is blocking; skill inputs count as generator companions
Owner decision 2026-11-15. The section-8 pass and the derived-families pass restored the translated catalogs, docs/i18n mirrors and generated files 67 open PRs carried; 6 known cases remain (an active session's PR, two forks without maintainer edits, two PRs deferred to v3.8.55, and a skills fix). check:pr-derived-paths now runs without --warn in PR Test Policy.

The generated family gains three companions: src/shared/constants/agentSkills.ts, skills/** and docs/openapi.yaml. A skills PR that changes the generator, its catalog or OpenAPI input and regenerates SKILL.md files its own test reads (#19635) is single-family and allowed; a route PR that also regenerates the skill references still fails. QUALITY_GATES.md lists derived-facts.json in the family table and the new companions.
2026-11-15 13:23:03 -03:00
..
2026-11-12 12:29:18 -03:00
2026-11-12 12:29:18 -03:00
2026-06-29 08:40:06 -03:00

title, version, lastUpdated
title version lastUpdated
OmniRoute Documentation 3.8.40 2026-06-28

OmniRoute Documentation

Navigable index of the OmniRoute documentation set. Topics are grouped by intent so you can find what you need quickly.

Looking for the project overview, install steps, or release notes? See the root README.md, ROADMAP.md, CHANGELOG.md, and CONTRIBUTING.md.


For Non-Tech Users

Simple guides for using OmniRoute — no technical background needed.

getting-started/

guides/


For Tech Users

Technical documentation for developers and contributors.

architecture/

How the system is put together — read these to understand the runtime, code layout, and resilience model.

reference/

Lookup material — API surface, environment variables, CLI flags, provider catalog.

frameworks/

Pluggable subsystems exposed to clients, agents, and operators.

routing/

Combo routing, scoring, and replay.

security/

Guardrails, compliance, stealth, and the mandatory patterns for handling public credentials and error messages.

compression/

Prompt compression engines, rules, and language packs.

providers/

Provider-specific integration guides.

comparison/

ops/

Release, deployment, proxies, tunnels, coverage, database, monitoring.

diagrams/

Mermaid sources and exported SVG/PNG diagrams referenced from the docs above. See diagrams/README.md.

i18n/

Translated mirrors of the documentation in 66 locales (plus the English originals — 67 languages in total). See i18n/README.md for the supported language list.

screenshots/

Static screenshots used by the dashboard and the README. Not part of the doc body.


Auto-generated artifacts

  • reference/PROVIDER_REFERENCE.md is generated by scripts/docs/gen-provider-reference.ts from src/shared/constants/providers.ts. Do not edit by hand.
  • The /docs UI is backed by Fumadocs MDX source generation from the subfolders above.