mirror of
https://github.com/diegosouzapw/OmniRoute.git
synced 2026-08-06 23:32:12 +03:00
18c1a2b43e
* docs: restore the Polish API_REFERENCE removed by #8823 `docs/reference/API_REFERENCE.md` lists Polish in its language index, but the target file no longer exists: #8823 ("replace outdated Polish docs with translation from latest English") deleted `docs/i18n/pl/docs/reference/API_REFERENCE.md` without writing a replacement. Every other one of the 31 linked languages still has the file. That leaves `check:doc-links` red — and because the Docs Gates job only runs on pull requests, the branch itself reports green while carrying the break. The first PR opened afterwards is what surfaces it, and it blocks every PR until fixed. Restored from `71c5a7592^`. The content is the pre-#8823 translation, which is by definition outdated relative to the English source — but an outdated translation behind a working link is strictly better than a 404, and the next translation pass will overwrite it. `check:doc-links` now passes (813 internal links, 0 broken). The same commit also removed four other Polish files (`cloudflare-zero-trust-guide.md`, `features/context-relay.md`, `reference/CLI-TOOLS.md`, `reference/ENVIRONMENT.md`). None of them is linked from a scanned index, so none breaks the gate; they are noted here so a later translation pass can decide whether they should come back too. * chore(quality): freeze the pre-existing exhaustive-deps error in ProviderAccountRoutingCard Second half of unbreaking the base. `lint:json --max-warnings 0` fails on `ProviderAccountRoutingCard.tsx:87` — `save` calls `load()` but declares only `[providerKey]`. Same root cause as the broken doc link in the previous commit: the Lint job is skipped on pushes to `release/**`, so the branch reports green while carrying the violation, and every PR inherits it. Frozen rather than fixed: adding `load` to the dependency array changes when the callback is recreated in a settings component, and that belongs in a change that can verify the card's behaviour. The entry keeps the gate meaningful for genuinely new warnings instead of leaving it red for everyone. With this and the restored Polish file, both gates pass on the base again.
title, version, lastUpdated
| title | version | lastUpdated |
|---|---|---|
| Dokumentacja OmniRoute | 3.8.40 | 2026-06-28 |
Dokumentacja OmniRoute
Nawigowalny indeks zestawu dokumentacji OmniRoute. Tematy są pogrupowane według celu, abyś szybko znalazł to, czego potrzebujesz.
Szukasz przeglądu projektu, kroków instalacji lub informacji o wydaniach? Zobacz główne pliki README.md, CHANGELOG.md oraz CONTRIBUTING.md.
Dla użytkowników nietechnicznych
Proste przewodniki po korzystaniu z OmniRoute — bez wymaganej wiedzy technicznej.
getting-started/
- QUICK-START.md — zainstaluj i uruchom OmniRoute w 3 minuty.
- AUTO-COMBO-GUIDE.md — pozwól OmniRoute wybrać dla Ciebie najlepsze AI.
- PROVIDERS-GUIDE.md — jak podłączyć dostawców AI.
- FREE-TIERS-GUIDE.md — darmowe AI bez karty kredytowej.
- TROUBLESHOOTING.md — rozwiązywanie typowych problemów.
guides/
- SETUP_GUIDE.md — pierwsza konfiguracja OmniRoute.
- USER_GUIDE.md — codzienne korzystanie z panelu i API.
- FEATURES.md — galeria funkcji panelu.
- TIERS.md — poziomy OmniRoute wyjaśnione (przewodnik użytkownika).
- USAGE_QUOTA_GUIDE.md — śledzenie użycia, limitów (quota) i wydatków.
- COST_TRACKING.md — śledzenie kosztów i wydatków.
- FREE_PROVIDER_RANKINGS.md — rankingi darmowych dostawców (Arena ELO).
- DOCKER_GUIDE.md — uruchamianie OmniRoute w Dockerze.
- ELECTRON_GUIDE.md — buildy desktopowe (Electron).
- TERMUX_GUIDE.md — uruchamianie na Androidzie przez Termux.
- PWA_GUIDE.md — instalacja panelu jako PWA.
- REMOTE-MODE.md — udostępnianie OmniRoute zdalnie + tokeny z zakresem (scoped tokens).
- CLI-INTEGRATIONS.md — główna tabela integracji CLI
setup-*. - CLAUDE-CODE-CONFIGURATION.md — Claude Code CLI z OmniRoute.
- CODEX-CLI-CONFIGURATION.md — Codex CLI z OmniRoute.
- KIRO_SETUP.md — konfiguracja Kiro.
- I18N.md — workflow tłumaczeń i locale.
- TROUBLESHOOTING.md — szczegółowa referencja rozwiązywania problemów.
- UNINSTALL.md — czyste usuwanie instalacji.
Dla użytkowników technicznych
Dokumentacja techniczna dla deweloperów i współtwórców.
architecture/
Jak zbudowany jest system — przeczytaj te materiały, aby zrozumieć runtime, układ kodu i model odporności.
- ARCHITECTURE.md — wysokopoziomowa architektura systemu (potok żądań, warstwy, moduły).
- CODEBASE_DOCUMENTATION.md — referencja inżynierska bazy kodu.
- REPOSITORY_MAP.md — przewodnik nawigacji katalog po katalogu.
- AUTHZ_GUIDE.md — potok autoryzacji (klasyfikator tras + silnik polityk).
- RESILIENCE_GUIDE.md — circuit breaker dostawcy, cooldown połączeń i lockout modeli.
- QUALITY_GATES.md — inwentarz skryptów bramek jakości i jobów CI.
- MONITORING_SECTIONS.md — nawigacja panelu monitoringu/kosztów.
- cluster-decisions.md — opcjonalne decyzje profili sidecar/klaster.
reference/
Materiały referencyjne — powierzchnia API, zmienne środowiskowe, flagi CLI, katalog dostawców.
- API_REFERENCE.md — endpointy REST API i kształty danych.
- PROVIDER_REFERENCE.md — automatycznie generowany katalog dostawców (nie edytuj ręcznie).
- PROVIDER_PLUGIN_MANIFEST.md — kontrakt wtyczki dostawcy bezpieczny dla sidecarów przy migracji Bifrost i CLIProxyAPI.
- openapi.yaml — specyfikacja OpenAPI publicznego API.
- ENVIRONMENT.md — referencja zmiennych środowiskowych.
- FEATURE_FLAGS.md — flagi funkcji i ich wartości domyślne.
- CLI-TOOLS.md — dołączone polecenia CLI.
- FREE_TIERS.md — katalog darmowych poziomów dostawców LLM.
frameworks/
Podsystemy wtykowe udostępniane klientom, agentom i operatorom.
- MCP-SERVER.md — serwer Model Context Protocol.
- A2A-SERVER.md — serwer Agent-to-Agent (A2A) JSON-RPC.
- ACP.md — Agent Client Protocol.
- AGENT_PROTOCOLS_GUIDE.md — przegląd agentów A2A / ACP / Cloud.
- AGENTBRIDGE.md — most agenta IDE.
- AGENT-SKILLS.md — katalog umiejętności agentów.
- CLOUD_AGENT.md — runtime i dostawcy cloud agent.
- SKILLS.md — framework Skills (piaskownicowe rozszerzenie).
- MEMORY.md — trwała pamięć (FTS5 + Qdrant).
- WEBHOOKS.md — zdarzenia webhook i dyspozycja.
- EVALS.md — zestawy ewaluacji.
- GAMIFICATION.md — system grywalizacji i rankingów.
- EMBEDDED-SERVICES.md — wbudowane usługi sidecar (9Router, CLIProxyAPI).
- NOTION_CONTEXT.md — źródło kontekstu Notion.
- OBSIDIAN_CONTEXT.md — źródło kontekstu Obsidian.
- OPENCODE.md — integracja OpenCode.
- OPEN_SSE_ARCHITECTURE.md — wnętrze silnika streamingu open-sse.
- PLAYGROUND_STUDIO.md — UI Playground Studio.
- SEARCH_TOOLS_STUDIO.md — UI Search Tools Studio.
- TRAFFIC_INSPECTOR.md — inspector ruchu (MITM).
- PLUGINS.md — przegląd systemu wtyczek CLI.
- PLUGIN_SDK.md — referencja SDK wtyczek.
- PLUGIN_MARKETPLACE.md — marketplace wtyczek.
routing/
Routing combo, scorowanie i replay.
- AUTO-COMBO.md — Auto-Combo (scorowanie wieloczynnikowe, 17 strategii).
- QUOTA_SHARE.md — silnik współdzielenia limitów (quota).
- REASONING_REPLAY.md — cache replay rozumowania (reasoning).
security/
Guardrails, zgodność (compliance), stealth oraz obowiązkowe wzorce obsługi publicznych poświadczeń i komunikatów błędów.
- GUARDRAILS.md — guardrails PII, prompt injection, vision.
- COMPLIANCE.md — ścieżki audytu i zgodność.
- STEALTH_GUIDE.md — stealth TLS / fingerprint.
- PUBLIC_CREDS.md — obowiązkowy wzorzec osadzania publicznych upstreamowych OAuth client_id/secret + kluczy Firebase Web bez uruchamiania skanerów sekretów.
- ERROR_SANITIZATION.md — obowiązkowy wzorzec kierowania każdej odpowiedzi błędu przez
sanitizeErrorMessage, aby zapobiec ujawnieniu stack-trace. - ROUTE_GUARD_TIERS.md — poziomy klasyfikacji route-guard.
- CLI_TOKEN.md — auth tokenu machine-ID CLI (HMAC + legacy SHA-256).
- EGRESS_POLICY.md — polityka rodziny IP egress (IPv4/IPv6).
- MITM-TPROXY-DECRYPT.md — przezroczyste deszyfrowanie MITM.
- SUPPLY_CHAIN.md — bramki łańcucha dostaw (SLSA, SBOM, Trivy, osv-scanner, Scorecard).
- SOCKET_DEV_FINDINGS.md — atestacje ustaleń łańcucha dostaw.
compression/
Silniki kompresji promptów, reguły i pakiety językowe.
- COMPRESSION_GUIDE.md — ogólny przegląd kompresji.
- COMPRESSION_ENGINES.md — dostępne silniki kompresji.
- COMPRESSION_RULES_FORMAT.md — format pliku reguł.
- COMPRESSION_LANGUAGE_PACKS.md — pakiety językowe.
- RTK_COMPRESSION.md — dogłębna analiza silnika RTK.
- CONTEXT_EDITING.md — delegowana edycja kontekstu (Anthropic).
- EXTENDING_COMPRESSION.md — dodawanie własnego silnika kompresji.
providers/
Przewodniki integracji specyficzne dla dostawców.
- CLAUDE_WEB.md — dostawca Claude Web (cookie-auth).
- AGENTROUTER.md — konfiguracja AgentRouter.
- ZED-DOCKER.md — integracja Zed IDE w Dockerze.
comparison/
- OMNIROUTE_VS_ALTERNATIVES.md — jak OmniRoute wypada na tle alternatyw.
ops/
Wydania, wdrożenia, proxy, tunele, pokrycie testami, baza danych, monitoring.
- RELEASE_CHECKLIST.md — checklista procesu wydania.
- RELEASE_GREEN.md — utrzymywanie kolejki PR i gałęzi wydania w stanie green.
- QUALITY_GATE_PLAYBOOK.md — playbook bramek jakości.
- BRANCH_PROTECTION_MAIN.md — ochrona gałęzi
main. - COVERAGE_PLAN.md — plan pokrycia testami.
- DATABASE_GUIDE.md — schemat DB i operacje.
- SQLITE_RUNTIME.md — łańcuch rozwiązywania sterownika SQLite.
- MONITORING_GUIDE.md — monitoring i obserwowalność.
- FLY_IO_DEPLOYMENT_GUIDE.md — wdrożenie na Fly.io.
- VM_DEPLOYMENT_GUIDE.md — generyczne wdrożenie na VM.
- PROXY_GUIDE.md — konfiguracja proxy upstream.
- TUNNELS_GUIDE.md — Cloudflare tunnel i pokrewne.
diagrams/
Źródła Mermaid oraz wyeksportowane diagramy SVG/PNG przywoływane w powyższej dokumentacji. Zobacz diagrams/README.md.
i18n/
Przetłumaczone lustrzane kopie dokumentacji w 43 locale. Listę obsługiwanych języków znajdziesz w i18n/README.md.
screenshots/
Statyczne zrzuty ekranu używane przez panel i README. Nie stanowią części treści dokumentacji.
Artefakty generowane automatycznie
- reference/PROVIDER_REFERENCE.md jest generowany przez
scripts/docs/gen-provider-reference.tszsrc/shared/constants/providers.ts. Nie edytuj ręcznie. - UI
/docsjest oparte na generowaniu źródeł Fumadocs MDX z powyższych podfolderów.