Files
OmniRoute/docs
diegosouzapw faa65df154 docs(ci): three omni-queue runbook sentences about withdrawals
docs/ops/OMNI_QUEUE.md:

- "Before a mode change or a stop", step 1: "history records no landed
  event" was too strong for the pause case. After a pause and a resume
  in live mode the next tick finds the candidate at the tip and records
  `landed`; only a base that then runs in shadow records none. The step
  now says both, and says to let the next live tick record a batch that
  is already the tip before pausing or changing the mode.
- Under the shadow table: a shadow tick also stores a withdrawal, when
  GitHub refuses its own withdrawal of a landing-stage batch. Reworded;
  the conclusion stays (every stored withdrawal comes from a batch live
  mode blessed, so a queue that was never live writes none).
- Step 2: a stored withdrawal dropped by the 20-entry limit leaves no
  field behind, so the operator also looks in the history for its error
  event, quoted as the code writes it ("<batchId>: stored withdrawal of
  <landing.statusContext> on <sha12> dropped (20 stored already); its
  newest status may still be success").
- "When the landing does not complete": the creator rule now says the
  rule of the previous commit (a status without a readable creator may
  only add a reason to withdraw, never remove one), and the prose lines
  past 100 columns are rewrapped.
2026-11-15 21:14:59 -03:00
..
2026-11-12 12:29:18 -03:00
2026-11-12 12:29:18 -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.