diff --git a/docs/i18n/ar/CHANGELOG.md b/docs/i18n/ar/CHANGELOG.md index 538f4faa10..eefda2a1d8 100644 --- a/docs/i18n/ar/CHANGELOG.md +++ b/docs/i18n/ar/CHANGELOG.md @@ -1310,7 +1310,7 @@ We identified that **155 community PRs** across the entire project history (from - **33 New API Key Providers:** Massive provider expansion adding DeepInfra, Vercel AI Gateway, Lambda AI, SambaNova, nScale, OVHcloud AI, Baseten, PublicAI, Moonshot AI, Meta Llama API, v0 (Vercel), Morph, Featherless AI, FriendliAI, LlamaGate, Galadriel, Weights & Biases Inference, Volcengine, AI21 Labs, Venice.ai, Codestral, Upstage, Maritalk, Xiaomi MiMo, Inference.net, NanoGPT, Predibase, Bytez, Heroku AI, Databricks, Snowflake Cortex, and GigaChat (Sber). OmniRoute now supports **100+ providers** (4 Free + 8 OAuth + 91 API Key + Custom compatible) - **Global Email Privacy Toggle:** Added a persistent eye-icon toggle button across all dashboard pages (Providers, Usage Limits, Playground) that reveals or hides masked email addresses. Toggle state is stored in localStorage and synced globally via Zustand store - **Documentation Refresh:** Updated README, ARCHITECTURE, FEATURES, AGENTS.md, and API_REFERENCE for v3.6.2 with accurate provider counts (100+), new executor list, and system API documentation -- **Uninstall Guide:** Created comprehensive `docs/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) +- **Uninstall Guide:** Created comprehensive `docs/guides/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) ### 🐛 Bug Fixes diff --git a/docs/i18n/ar/CONTRIBUTING.md b/docs/i18n/ar/CONTRIBUTING.md index 99445d9934..2f576a9f93 100644 --- a/docs/i18n/ar/CONTRIBUTING.md +++ b/docs/i18n/ar/CONTRIBUTING.md @@ -153,7 +153,7 @@ Coverage notes: - If a PR changes production code in `src/`, `open-sse/`, `electron/`, or `bin/`, it must add or update automated tests in the same PR - `npm run coverage:report` prints the detailed file-by-file report from the latest coverage run - `npm run test:coverage:legacy` preserves the older metric for historical comparison -- See `docs/COVERAGE_PLAN.md` for the phased coverage improvement roadmap +- See `docs/ops/COVERAGE_PLAN.md` for the phased coverage improvement roadmap ### Pull Request Requirements @@ -305,7 +305,7 @@ Releases are managed via the `/generate-release` workflow. When a new GitHub Rel ## Getting Help -- **Architecture**: See [`docs/ARCHITECTURE.md`](docs/ARCHITECTURE.md) -- **API Reference**: See [`docs/API_REFERENCE.md`](docs/API_REFERENCE.md) +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](docs/architecture/ARCHITECTURE.md) +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](docs/reference/API_REFERENCE.md) - **Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) - **ADRs**: See `docs/adr/` for architectural decision records diff --git a/docs/i18n/ar/README.md b/docs/i18n/ar/README.md index 2979af725a..72df057567 100644 --- a/docs/i18n/ar/README.md +++ b/docs/i18n/ar/README.md @@ -2267,25 +2267,25 @@ Se não quiser criar credenciais próprias agora, ainda é possível usar o flux ## التوثيق -| Document | Description | -| -------------------------------------------------------- | --------------------------------------------------- | -| [User Guide](docs/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | -| [API Reference](docs/API_REFERENCE.md) | All endpoints with examples | -| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | -| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | -| [Auto-Combo Engine](docs/AUTO-COMBO.md) | 6-factor scoring, mode packs, self-healing | -| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | -| [Troubleshooting](docs/TROUBLESHOOTING.md) | Common problems and solutions | -| [Architecture](docs/ARCHITECTURE.md) | System architecture and internals | -| [Codebase Documentation](docs/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | -| [Uninstall Guide](docs/UNINSTALL.md) | Clean removal for all install methods | -| [Environment Config](docs/ENVIRONMENT.md) | Complete `.env` variables and references | -| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | -| [OpenAPI Spec](docs/openapi.yaml) | OpenAPI 3.0 specification | -| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | -| [VM Deployment](docs/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | -| [Features Gallery](docs/FEATURES.md) | Visual dashboard tour with screenshots | -| [Release Checklist](docs/RELEASE_CHECKLIST.md) | Pre-release validation steps | +| Document | Description | +| --------------------------------------------------------------------- | --------------------------------------------------- | +| [User Guide](docs/guides/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | +| [API Reference](docs/reference/API_REFERENCE.md) | All endpoints with examples | +| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | +| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | +| [Auto-Combo Engine](docs/routing/AUTO-COMBO.md) | 6-factor scoring, mode packs, self-healing | +| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | +| [Troubleshooting](docs/guides/TROUBLESHOOTING.md) | Common problems and solutions | +| [Architecture](docs/architecture/ARCHITECTURE.md) | System architecture and internals | +| [Codebase Documentation](docs/architecture/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | +| [Uninstall Guide](docs/guides/UNINSTALL.md) | Clean removal for all install methods | +| [Environment Config](docs/reference/ENVIRONMENT.md) | Complete `.env` variables and references | +| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | +| [OpenAPI Spec](docs/reference/openapi.yaml) | OpenAPI 3.0 specification | +| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | +| [VM Deployment](docs/ops/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | +| [Features Gallery](docs/guides/FEATURES.md) | Visual dashboard tour with screenshots | +| [Release Checklist](docs/ops/RELEASE_CHECKLIST.md) | Pre-release validation steps | --- diff --git a/docs/i18n/ar/docs/ARCHITECTURE.md b/docs/i18n/ar/docs/architecture/ARCHITECTURE.md similarity index 100% rename from docs/i18n/ar/docs/ARCHITECTURE.md rename to docs/i18n/ar/docs/architecture/ARCHITECTURE.md diff --git a/docs/i18n/ar/docs/CODEBASE_DOCUMENTATION.md b/docs/i18n/ar/docs/architecture/CODEBASE_DOCUMENTATION.md similarity index 100% rename from docs/i18n/ar/docs/CODEBASE_DOCUMENTATION.md rename to docs/i18n/ar/docs/architecture/CODEBASE_DOCUMENTATION.md diff --git a/docs/i18n/ar/docs/A2A-SERVER.md b/docs/i18n/ar/docs/frameworks/A2A-SERVER.md similarity index 100% rename from docs/i18n/ar/docs/A2A-SERVER.md rename to docs/i18n/ar/docs/frameworks/A2A-SERVER.md diff --git a/docs/i18n/ar/docs/MCP-SERVER.md b/docs/i18n/ar/docs/frameworks/MCP-SERVER.md similarity index 100% rename from docs/i18n/ar/docs/MCP-SERVER.md rename to docs/i18n/ar/docs/frameworks/MCP-SERVER.md diff --git a/docs/i18n/ar/docs/FEATURES.md b/docs/i18n/ar/docs/guides/FEATURES.md similarity index 100% rename from docs/i18n/ar/docs/FEATURES.md rename to docs/i18n/ar/docs/guides/FEATURES.md diff --git a/docs/i18n/ar/docs/I18N.md b/docs/i18n/ar/docs/guides/I18N.md similarity index 99% rename from docs/i18n/ar/docs/I18N.md rename to docs/i18n/ar/docs/guides/I18N.md index b06c7fcfde..12c918a5c0 100644 --- a/docs/i18n/ar/docs/I18N.md +++ b/docs/i18n/ar/docs/guides/I18N.md @@ -420,7 +420,7 @@ The generator originally used `code: "in"` (deprecated Google Translate code) fo ### `docs/i18n/README.md` Is Auto-Generated -The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/I18N.md` (this file) for hand-written documentation that should persist. +The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/guides/I18N.md` (this file) for hand-written documentation that should persist. ### External Untranslatable Keys List diff --git a/docs/i18n/ar/docs/TROUBLESHOOTING.md b/docs/i18n/ar/docs/guides/TROUBLESHOOTING.md similarity index 98% rename from docs/i18n/ar/docs/TROUBLESHOOTING.md rename to docs/i18n/ar/docs/guides/TROUBLESHOOTING.md index 43fb904f44..8ed817811a 100644 --- a/docs/i18n/ar/docs/TROUBLESHOOTING.md +++ b/docs/i18n/ar/docs/guides/TROUBLESHOOTING.md @@ -335,7 +335,7 @@ You can ignore this section if you do not run RAG or agent pipelines behind Omni ## Still Stuck? - **GitHub Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) -- **Architecture**: See [`docs/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details -- **API Reference**: See [`docs/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints - **Health Dashboard**: Check **Dashboard → Health** for real-time system status - **Translator**: Use **Dashboard → Translator** to debug format issues diff --git a/docs/i18n/ar/docs/UNINSTALL.md b/docs/i18n/ar/docs/guides/UNINSTALL.md similarity index 100% rename from docs/i18n/ar/docs/UNINSTALL.md rename to docs/i18n/ar/docs/guides/UNINSTALL.md diff --git a/docs/i18n/ar/docs/USER_GUIDE.md b/docs/i18n/ar/docs/guides/USER_GUIDE.md similarity index 100% rename from docs/i18n/ar/docs/USER_GUIDE.md rename to docs/i18n/ar/docs/guides/USER_GUIDE.md diff --git a/docs/i18n/ar/docs/COVERAGE_PLAN.md b/docs/i18n/ar/docs/ops/COVERAGE_PLAN.md similarity index 100% rename from docs/i18n/ar/docs/COVERAGE_PLAN.md rename to docs/i18n/ar/docs/ops/COVERAGE_PLAN.md diff --git a/docs/i18n/ar/docs/FLY_IO_DEPLOYMENT_GUIDE.md b/docs/i18n/ar/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/ar/docs/FLY_IO_DEPLOYMENT_GUIDE.md rename to docs/i18n/ar/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/ar/docs/RELEASE_CHECKLIST.md b/docs/i18n/ar/docs/ops/RELEASE_CHECKLIST.md similarity index 94% rename from docs/i18n/ar/docs/RELEASE_CHECKLIST.md rename to docs/i18n/ar/docs/ops/RELEASE_CHECKLIST.md index c4230bf085..755d2d1f09 100644 --- a/docs/i18n/ar/docs/RELEASE_CHECKLIST.md +++ b/docs/i18n/ar/docs/ops/RELEASE_CHECKLIST.md @@ -16,14 +16,14 @@ Use this checklist before tagging or publishing a new OmniRoute release. ## API Docs -1. Update `docs/openapi.yaml`: +1. Update `docs/reference/openapi.yaml`: - `info.version` must equal `package.json` version. 2. Validate endpoint examples if API contracts changed. ## Runtime Docs -1. Review `docs/ARCHITECTURE.md` for storage/runtime drift. -2. Review `docs/TROUBLESHOOTING.md` for env var and operational drift. +1. Review `docs/architecture/ARCHITECTURE.md` for storage/runtime drift. +2. Review `docs/guides/TROUBLESHOOTING.md` for env var and operational drift. 3. Verify the release/runtime Node.js version still satisfies the supported secure floor: - `>=20.20.2 <21` or `>=22.22.2 <23` - `npm run check:node-runtime` diff --git a/docs/i18n/ar/docs/VM_DEPLOYMENT_GUIDE.md b/docs/i18n/ar/docs/ops/VM_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/ar/docs/VM_DEPLOYMENT_GUIDE.md rename to docs/i18n/ar/docs/ops/VM_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/ar/docs/API_REFERENCE.md b/docs/i18n/ar/docs/reference/API_REFERENCE.md similarity index 100% rename from docs/i18n/ar/docs/API_REFERENCE.md rename to docs/i18n/ar/docs/reference/API_REFERENCE.md diff --git a/docs/i18n/ar/docs/CLI-TOOLS.md b/docs/i18n/ar/docs/reference/CLI-TOOLS.md similarity index 100% rename from docs/i18n/ar/docs/CLI-TOOLS.md rename to docs/i18n/ar/docs/reference/CLI-TOOLS.md diff --git a/docs/i18n/ar/docs/ENVIRONMENT.md b/docs/i18n/ar/docs/reference/ENVIRONMENT.md similarity index 100% rename from docs/i18n/ar/docs/ENVIRONMENT.md rename to docs/i18n/ar/docs/reference/ENVIRONMENT.md diff --git a/docs/i18n/ar/docs/AUTO-COMBO.md b/docs/i18n/ar/docs/routing/AUTO-COMBO.md similarity index 100% rename from docs/i18n/ar/docs/AUTO-COMBO.md rename to docs/i18n/ar/docs/routing/AUTO-COMBO.md diff --git a/docs/i18n/ar/llm.txt b/docs/i18n/ar/llm.txt index f632acf7a0..30d8e0afe8 100644 --- a/docs/i18n/ar/llm.txt +++ b/docs/i18n/ar/llm.txt @@ -357,11 +357,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### MCP Server (37 Tools) | Category | Tools | |------------|-------| -| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/MCP-SERVER.md` for full inventory) | +| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/frameworks/MCP-SERVER.md` for full inventory) | | Memory (3) | `memory_search`, `memory_add`, `memory_clear` | | Skills (4) | `skills_list`, `skills_enable`, `skills_execute`, `skills_executions` | -**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/MCP-SERVER.md`. +**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/frameworks/MCP-SERVER.md`. ### Provider Categories @@ -472,7 +472,7 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo 20. **Guardrails framework** in `src/lib/guardrails/` — hot-reloadable registry. Built-ins (priority-ordered): `vision-bridge` (5) → `pii-masker` (10) → `prompt-injection` (20). Fail-open model: exceptions never block traffic. Per-request opt-out via `x-omniroute-disabled-guardrails` header. -21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/AUTHZ_GUIDE.md`. +21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/architecture/AUTHZ_GUIDE.md`. 22. **Three resilience layers** are distinct (do not conflate them): - **Provider Circuit Breaker** (`src/shared/utils/circuitBreaker.ts`) — whole-provider scope. @@ -489,11 +489,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo - **MCP server expanded to 37 tools** (30 base + 3 memory + 4 skills) across ~13 scopes - **OAuth providers expanded to 14**: added Qwen, Kiro, Qoder, Gemini, Windsurf, GitLab Duo - **Coverage gate raised to 75/75/75/70** (was 60% across the board) — measured ~82% -- **Reasoning replay** (`docs/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams +- **Reasoning replay** (`docs/routing/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams - **Compliance + Evals + Webhooks** documentation introduced -- **Stealth guide** (`docs/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration -- **Tunnels guide** (`docs/TUNNELS_GUIDE.md`) — Cloudflare tunnel management -- **Electron guide** (`docs/ELECTRON_GUIDE.md`) — desktop app build + signing +- **Stealth guide** (`docs/security/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration +- **Tunnels guide** (`docs/ops/TUNNELS_GUIDE.md`) — Cloudflare tunnel management +- **Electron guide** (`docs/guides/ELECTRON_GUIDE.md`) — desktop app build + signing ## Links @@ -505,11 +505,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### Documentation Index -- **Architecture & Reference**: `docs/ARCHITECTURE.md`, `docs/CODEBASE_DOCUMENTATION.md`, `docs/REPOSITORY_MAP.md`, `docs/API_REFERENCE.md`, `docs/PROVIDER_REFERENCE.md`, `docs/openapi.yaml` -- **Operator guides**: `docs/USER_GUIDE.md`, `docs/CLI-TOOLS.md`, `docs/TROUBLESHOOTING.md`, `docs/COVERAGE_PLAN.md` -- **Protocols**: `docs/MCP-SERVER.md`, `docs/A2A-SERVER.md`, `docs/AGENT_PROTOCOLS_GUIDE.md`, `docs/CLOUD_AGENT.md` -- **Routing & resilience**: `docs/AUTO-COMBO.md`, `docs/RESILIENCE_GUIDE.md` -- **Security**: `docs/AUTHZ_GUIDE.md`, `docs/GUARDRAILS.md`, `docs/COMPLIANCE.md`, `docs/STEALTH_GUIDE.md` -- **Extensibility**: `docs/SKILLS.md`, `docs/MEMORY.md`, `docs/EVALS.md`, `docs/WEBHOOKS.md`, `docs/REASONING_REPLAY.md` -- **Platform**: `docs/ELECTRON_GUIDE.md`, `docs/TUNNELS_GUIDE.md` +- **Architecture & Reference**: `docs/architecture/ARCHITECTURE.md`, `docs/architecture/CODEBASE_DOCUMENTATION.md`, `docs/architecture/REPOSITORY_MAP.md`, `docs/reference/API_REFERENCE.md`, `docs/reference/PROVIDER_REFERENCE.md`, `docs/reference/openapi.yaml` +- **Operator guides**: `docs/guides/USER_GUIDE.md`, `docs/reference/CLI-TOOLS.md`, `docs/guides/TROUBLESHOOTING.md`, `docs/ops/COVERAGE_PLAN.md` +- **Protocols**: `docs/frameworks/MCP-SERVER.md`, `docs/frameworks/A2A-SERVER.md`, `docs/frameworks/AGENT_PROTOCOLS_GUIDE.md`, `docs/frameworks/CLOUD_AGENT.md` +- **Routing & resilience**: `docs/routing/AUTO-COMBO.md`, `docs/architecture/RESILIENCE_GUIDE.md` +- **Security**: `docs/architecture/AUTHZ_GUIDE.md`, `docs/security/GUARDRAILS.md`, `docs/security/COMPLIANCE.md`, `docs/security/STEALTH_GUIDE.md` +- **Extensibility**: `docs/frameworks/SKILLS.md`, `docs/frameworks/MEMORY.md`, `docs/frameworks/EVALS.md`, `docs/frameworks/WEBHOOKS.md`, `docs/routing/REASONING_REPLAY.md` +- **Platform**: `docs/guides/ELECTRON_GUIDE.md`, `docs/ops/TUNNELS_GUIDE.md` - **AI agents**: `CLAUDE.md`, `AGENTS.md`, `GEMINI.md` diff --git a/docs/i18n/bg/CHANGELOG.md b/docs/i18n/bg/CHANGELOG.md index faeb5ab80c..4e0dc7fdb9 100644 --- a/docs/i18n/bg/CHANGELOG.md +++ b/docs/i18n/bg/CHANGELOG.md @@ -1310,7 +1310,7 @@ We identified that **155 community PRs** across the entire project history (from - **33 New API Key Providers:** Massive provider expansion adding DeepInfra, Vercel AI Gateway, Lambda AI, SambaNova, nScale, OVHcloud AI, Baseten, PublicAI, Moonshot AI, Meta Llama API, v0 (Vercel), Morph, Featherless AI, FriendliAI, LlamaGate, Galadriel, Weights & Biases Inference, Volcengine, AI21 Labs, Venice.ai, Codestral, Upstage, Maritalk, Xiaomi MiMo, Inference.net, NanoGPT, Predibase, Bytez, Heroku AI, Databricks, Snowflake Cortex, and GigaChat (Sber). OmniRoute now supports **100+ providers** (4 Free + 8 OAuth + 91 API Key + Custom compatible) - **Global Email Privacy Toggle:** Added a persistent eye-icon toggle button across all dashboard pages (Providers, Usage Limits, Playground) that reveals or hides masked email addresses. Toggle state is stored in localStorage and synced globally via Zustand store - **Documentation Refresh:** Updated README, ARCHITECTURE, FEATURES, AGENTS.md, and API_REFERENCE for v3.6.2 with accurate provider counts (100+), new executor list, and system API documentation -- **Uninstall Guide:** Created comprehensive `docs/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) +- **Uninstall Guide:** Created comprehensive `docs/guides/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) ### 🐛 Bug Fixes diff --git a/docs/i18n/bg/CONTRIBUTING.md b/docs/i18n/bg/CONTRIBUTING.md index 37916a0c71..4d9aee0886 100644 --- a/docs/i18n/bg/CONTRIBUTING.md +++ b/docs/i18n/bg/CONTRIBUTING.md @@ -153,7 +153,7 @@ Coverage notes: - If a PR changes production code in `src/`, `open-sse/`, `electron/`, or `bin/`, it must add or update automated tests in the same PR - `npm run coverage:report` prints the detailed file-by-file report from the latest coverage run - `npm run test:coverage:legacy` preserves the older metric for historical comparison -- See `docs/COVERAGE_PLAN.md` for the phased coverage improvement roadmap +- See `docs/ops/COVERAGE_PLAN.md` for the phased coverage improvement roadmap ### Pull Request Requirements @@ -305,7 +305,7 @@ Releases are managed via the `/generate-release` workflow. When a new GitHub Rel ## Getting Help -- **Architecture**: See [`docs/ARCHITECTURE.md`](docs/ARCHITECTURE.md) -- **API Reference**: See [`docs/API_REFERENCE.md`](docs/API_REFERENCE.md) +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](docs/architecture/ARCHITECTURE.md) +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](docs/reference/API_REFERENCE.md) - **Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) - **ADRs**: See `docs/adr/` for architectural decision records diff --git a/docs/i18n/bg/README.md b/docs/i18n/bg/README.md index e8812921d9..5fa29ec06e 100644 --- a/docs/i18n/bg/README.md +++ b/docs/i18n/bg/README.md @@ -2267,25 +2267,25 @@ Se não quiser criar credenciais próprias agora, ainda é possível usar o flux ## Документация -| Document | Description | -| -------------------------------------------------------- | --------------------------------------------------- | -| [User Guide](docs/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | -| [API Reference](docs/API_REFERENCE.md) | All endpoints with examples | -| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | -| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | -| [Auto-Combo Engine](docs/AUTO-COMBO.md) | 6-factor scoring, mode packs, self-healing | -| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | -| [Troubleshooting](docs/TROUBLESHOOTING.md) | Common problems and solutions | -| [Architecture](docs/ARCHITECTURE.md) | System architecture and internals | -| [Codebase Documentation](docs/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | -| [Uninstall Guide](docs/UNINSTALL.md) | Clean removal for all install methods | -| [Environment Config](docs/ENVIRONMENT.md) | Complete `.env` variables and references | -| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | -| [OpenAPI Spec](docs/openapi.yaml) | OpenAPI 3.0 specification | -| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | -| [VM Deployment](docs/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | -| [Features Gallery](docs/FEATURES.md) | Visual dashboard tour with screenshots | -| [Release Checklist](docs/RELEASE_CHECKLIST.md) | Pre-release validation steps | +| Document | Description | +| --------------------------------------------------------------------- | --------------------------------------------------- | +| [User Guide](docs/guides/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | +| [API Reference](docs/reference/API_REFERENCE.md) | All endpoints with examples | +| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | +| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | +| [Auto-Combo Engine](docs/routing/AUTO-COMBO.md) | 6-factor scoring, mode packs, self-healing | +| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | +| [Troubleshooting](docs/guides/TROUBLESHOOTING.md) | Common problems and solutions | +| [Architecture](docs/architecture/ARCHITECTURE.md) | System architecture and internals | +| [Codebase Documentation](docs/architecture/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | +| [Uninstall Guide](docs/guides/UNINSTALL.md) | Clean removal for all install methods | +| [Environment Config](docs/reference/ENVIRONMENT.md) | Complete `.env` variables and references | +| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | +| [OpenAPI Spec](docs/reference/openapi.yaml) | OpenAPI 3.0 specification | +| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | +| [VM Deployment](docs/ops/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | +| [Features Gallery](docs/guides/FEATURES.md) | Visual dashboard tour with screenshots | +| [Release Checklist](docs/ops/RELEASE_CHECKLIST.md) | Pre-release validation steps | --- diff --git a/docs/i18n/bg/docs/ARCHITECTURE.md b/docs/i18n/bg/docs/architecture/ARCHITECTURE.md similarity index 100% rename from docs/i18n/bg/docs/ARCHITECTURE.md rename to docs/i18n/bg/docs/architecture/ARCHITECTURE.md diff --git a/docs/i18n/bg/docs/CODEBASE_DOCUMENTATION.md b/docs/i18n/bg/docs/architecture/CODEBASE_DOCUMENTATION.md similarity index 100% rename from docs/i18n/bg/docs/CODEBASE_DOCUMENTATION.md rename to docs/i18n/bg/docs/architecture/CODEBASE_DOCUMENTATION.md diff --git a/docs/i18n/bg/docs/A2A-SERVER.md b/docs/i18n/bg/docs/frameworks/A2A-SERVER.md similarity index 100% rename from docs/i18n/bg/docs/A2A-SERVER.md rename to docs/i18n/bg/docs/frameworks/A2A-SERVER.md diff --git a/docs/i18n/bg/docs/MCP-SERVER.md b/docs/i18n/bg/docs/frameworks/MCP-SERVER.md similarity index 100% rename from docs/i18n/bg/docs/MCP-SERVER.md rename to docs/i18n/bg/docs/frameworks/MCP-SERVER.md diff --git a/docs/i18n/bg/docs/FEATURES.md b/docs/i18n/bg/docs/guides/FEATURES.md similarity index 100% rename from docs/i18n/bg/docs/FEATURES.md rename to docs/i18n/bg/docs/guides/FEATURES.md diff --git a/docs/i18n/bg/docs/I18N.md b/docs/i18n/bg/docs/guides/I18N.md similarity index 99% rename from docs/i18n/bg/docs/I18N.md rename to docs/i18n/bg/docs/guides/I18N.md index 0ceaabc575..e72d17e859 100644 --- a/docs/i18n/bg/docs/I18N.md +++ b/docs/i18n/bg/docs/guides/I18N.md @@ -420,7 +420,7 @@ The generator originally used `code: "in"` (deprecated Google Translate code) fo ### `docs/i18n/README.md` Is Auto-Generated -The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/I18N.md` (this file) for hand-written documentation that should persist. +The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/guides/I18N.md` (this file) for hand-written documentation that should persist. ### External Untranslatable Keys List diff --git a/docs/i18n/bg/docs/TROUBLESHOOTING.md b/docs/i18n/bg/docs/guides/TROUBLESHOOTING.md similarity index 98% rename from docs/i18n/bg/docs/TROUBLESHOOTING.md rename to docs/i18n/bg/docs/guides/TROUBLESHOOTING.md index e45a1a1257..84d2d262bc 100644 --- a/docs/i18n/bg/docs/TROUBLESHOOTING.md +++ b/docs/i18n/bg/docs/guides/TROUBLESHOOTING.md @@ -335,7 +335,7 @@ You can ignore this section if you do not run RAG or agent pipelines behind Omni ## Still Stuck? - **GitHub Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) -- **Architecture**: See [`docs/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details -- **API Reference**: See [`docs/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints - **Health Dashboard**: Check **Dashboard → Health** for real-time system status - **Translator**: Use **Dashboard → Translator** to debug format issues diff --git a/docs/i18n/bg/docs/UNINSTALL.md b/docs/i18n/bg/docs/guides/UNINSTALL.md similarity index 100% rename from docs/i18n/bg/docs/UNINSTALL.md rename to docs/i18n/bg/docs/guides/UNINSTALL.md diff --git a/docs/i18n/bg/docs/USER_GUIDE.md b/docs/i18n/bg/docs/guides/USER_GUIDE.md similarity index 100% rename from docs/i18n/bg/docs/USER_GUIDE.md rename to docs/i18n/bg/docs/guides/USER_GUIDE.md diff --git a/docs/i18n/bg/docs/COVERAGE_PLAN.md b/docs/i18n/bg/docs/ops/COVERAGE_PLAN.md similarity index 100% rename from docs/i18n/bg/docs/COVERAGE_PLAN.md rename to docs/i18n/bg/docs/ops/COVERAGE_PLAN.md diff --git a/docs/i18n/bg/docs/FLY_IO_DEPLOYMENT_GUIDE.md b/docs/i18n/bg/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/bg/docs/FLY_IO_DEPLOYMENT_GUIDE.md rename to docs/i18n/bg/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/bg/docs/RELEASE_CHECKLIST.md b/docs/i18n/bg/docs/ops/RELEASE_CHECKLIST.md similarity index 94% rename from docs/i18n/bg/docs/RELEASE_CHECKLIST.md rename to docs/i18n/bg/docs/ops/RELEASE_CHECKLIST.md index ea33f5c610..725dbb5c2e 100644 --- a/docs/i18n/bg/docs/RELEASE_CHECKLIST.md +++ b/docs/i18n/bg/docs/ops/RELEASE_CHECKLIST.md @@ -16,14 +16,14 @@ Use this checklist before tagging or publishing a new OmniRoute release. ## API Docs -1. Update `docs/openapi.yaml`: +1. Update `docs/reference/openapi.yaml`: - `info.version` must equal `package.json` version. 2. Validate endpoint examples if API contracts changed. ## Runtime Docs -1. Review `docs/ARCHITECTURE.md` for storage/runtime drift. -2. Review `docs/TROUBLESHOOTING.md` for env var and operational drift. +1. Review `docs/architecture/ARCHITECTURE.md` for storage/runtime drift. +2. Review `docs/guides/TROUBLESHOOTING.md` for env var and operational drift. 3. Verify the release/runtime Node.js version still satisfies the supported secure floor: - `>=20.20.2 <21` or `>=22.22.2 <23` - `npm run check:node-runtime` diff --git a/docs/i18n/bg/docs/VM_DEPLOYMENT_GUIDE.md b/docs/i18n/bg/docs/ops/VM_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/bg/docs/VM_DEPLOYMENT_GUIDE.md rename to docs/i18n/bg/docs/ops/VM_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/bg/docs/API_REFERENCE.md b/docs/i18n/bg/docs/reference/API_REFERENCE.md similarity index 100% rename from docs/i18n/bg/docs/API_REFERENCE.md rename to docs/i18n/bg/docs/reference/API_REFERENCE.md diff --git a/docs/i18n/bg/docs/CLI-TOOLS.md b/docs/i18n/bg/docs/reference/CLI-TOOLS.md similarity index 100% rename from docs/i18n/bg/docs/CLI-TOOLS.md rename to docs/i18n/bg/docs/reference/CLI-TOOLS.md diff --git a/docs/i18n/bg/docs/ENVIRONMENT.md b/docs/i18n/bg/docs/reference/ENVIRONMENT.md similarity index 100% rename from docs/i18n/bg/docs/ENVIRONMENT.md rename to docs/i18n/bg/docs/reference/ENVIRONMENT.md diff --git a/docs/i18n/bg/docs/AUTO-COMBO.md b/docs/i18n/bg/docs/routing/AUTO-COMBO.md similarity index 100% rename from docs/i18n/bg/docs/AUTO-COMBO.md rename to docs/i18n/bg/docs/routing/AUTO-COMBO.md diff --git a/docs/i18n/bg/llm.txt b/docs/i18n/bg/llm.txt index a3cf0bc811..d752b57e3e 100644 --- a/docs/i18n/bg/llm.txt +++ b/docs/i18n/bg/llm.txt @@ -357,11 +357,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### MCP Server (37 Tools) | Category | Tools | |------------|-------| -| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/MCP-SERVER.md` for full inventory) | +| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/frameworks/MCP-SERVER.md` for full inventory) | | Memory (3) | `memory_search`, `memory_add`, `memory_clear` | | Skills (4) | `skills_list`, `skills_enable`, `skills_execute`, `skills_executions` | -**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/MCP-SERVER.md`. +**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/frameworks/MCP-SERVER.md`. ### Provider Categories @@ -472,7 +472,7 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo 20. **Guardrails framework** in `src/lib/guardrails/` — hot-reloadable registry. Built-ins (priority-ordered): `vision-bridge` (5) → `pii-masker` (10) → `prompt-injection` (20). Fail-open model: exceptions never block traffic. Per-request opt-out via `x-omniroute-disabled-guardrails` header. -21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/AUTHZ_GUIDE.md`. +21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/architecture/AUTHZ_GUIDE.md`. 22. **Three resilience layers** are distinct (do not conflate them): - **Provider Circuit Breaker** (`src/shared/utils/circuitBreaker.ts`) — whole-provider scope. @@ -489,11 +489,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo - **MCP server expanded to 37 tools** (30 base + 3 memory + 4 skills) across ~13 scopes - **OAuth providers expanded to 14**: added Qwen, Kiro, Qoder, Gemini, Windsurf, GitLab Duo - **Coverage gate raised to 75/75/75/70** (was 60% across the board) — measured ~82% -- **Reasoning replay** (`docs/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams +- **Reasoning replay** (`docs/routing/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams - **Compliance + Evals + Webhooks** documentation introduced -- **Stealth guide** (`docs/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration -- **Tunnels guide** (`docs/TUNNELS_GUIDE.md`) — Cloudflare tunnel management -- **Electron guide** (`docs/ELECTRON_GUIDE.md`) — desktop app build + signing +- **Stealth guide** (`docs/security/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration +- **Tunnels guide** (`docs/ops/TUNNELS_GUIDE.md`) — Cloudflare tunnel management +- **Electron guide** (`docs/guides/ELECTRON_GUIDE.md`) — desktop app build + signing ## Links @@ -505,11 +505,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### Documentation Index -- **Architecture & Reference**: `docs/ARCHITECTURE.md`, `docs/CODEBASE_DOCUMENTATION.md`, `docs/REPOSITORY_MAP.md`, `docs/API_REFERENCE.md`, `docs/PROVIDER_REFERENCE.md`, `docs/openapi.yaml` -- **Operator guides**: `docs/USER_GUIDE.md`, `docs/CLI-TOOLS.md`, `docs/TROUBLESHOOTING.md`, `docs/COVERAGE_PLAN.md` -- **Protocols**: `docs/MCP-SERVER.md`, `docs/A2A-SERVER.md`, `docs/AGENT_PROTOCOLS_GUIDE.md`, `docs/CLOUD_AGENT.md` -- **Routing & resilience**: `docs/AUTO-COMBO.md`, `docs/RESILIENCE_GUIDE.md` -- **Security**: `docs/AUTHZ_GUIDE.md`, `docs/GUARDRAILS.md`, `docs/COMPLIANCE.md`, `docs/STEALTH_GUIDE.md` -- **Extensibility**: `docs/SKILLS.md`, `docs/MEMORY.md`, `docs/EVALS.md`, `docs/WEBHOOKS.md`, `docs/REASONING_REPLAY.md` -- **Platform**: `docs/ELECTRON_GUIDE.md`, `docs/TUNNELS_GUIDE.md` +- **Architecture & Reference**: `docs/architecture/ARCHITECTURE.md`, `docs/architecture/CODEBASE_DOCUMENTATION.md`, `docs/architecture/REPOSITORY_MAP.md`, `docs/reference/API_REFERENCE.md`, `docs/reference/PROVIDER_REFERENCE.md`, `docs/reference/openapi.yaml` +- **Operator guides**: `docs/guides/USER_GUIDE.md`, `docs/reference/CLI-TOOLS.md`, `docs/guides/TROUBLESHOOTING.md`, `docs/ops/COVERAGE_PLAN.md` +- **Protocols**: `docs/frameworks/MCP-SERVER.md`, `docs/frameworks/A2A-SERVER.md`, `docs/frameworks/AGENT_PROTOCOLS_GUIDE.md`, `docs/frameworks/CLOUD_AGENT.md` +- **Routing & resilience**: `docs/routing/AUTO-COMBO.md`, `docs/architecture/RESILIENCE_GUIDE.md` +- **Security**: `docs/architecture/AUTHZ_GUIDE.md`, `docs/security/GUARDRAILS.md`, `docs/security/COMPLIANCE.md`, `docs/security/STEALTH_GUIDE.md` +- **Extensibility**: `docs/frameworks/SKILLS.md`, `docs/frameworks/MEMORY.md`, `docs/frameworks/EVALS.md`, `docs/frameworks/WEBHOOKS.md`, `docs/routing/REASONING_REPLAY.md` +- **Platform**: `docs/guides/ELECTRON_GUIDE.md`, `docs/ops/TUNNELS_GUIDE.md` - **AI agents**: `CLAUDE.md`, `AGENTS.md`, `GEMINI.md` diff --git a/docs/i18n/bn/CHANGELOG.md b/docs/i18n/bn/CHANGELOG.md index ff78a5c462..571671965b 100644 --- a/docs/i18n/bn/CHANGELOG.md +++ b/docs/i18n/bn/CHANGELOG.md @@ -1310,7 +1310,7 @@ We identified that **155 community PRs** across the entire project history (from - **33 New API Key Providers:** Massive provider expansion adding DeepInfra, Vercel AI Gateway, Lambda AI, SambaNova, nScale, OVHcloud AI, Baseten, PublicAI, Moonshot AI, Meta Llama API, v0 (Vercel), Morph, Featherless AI, FriendliAI, LlamaGate, Galadriel, Weights & Biases Inference, Volcengine, AI21 Labs, Venice.ai, Codestral, Upstage, Maritalk, Xiaomi MiMo, Inference.net, NanoGPT, Predibase, Bytez, Heroku AI, Databricks, Snowflake Cortex, and GigaChat (Sber). OmniRoute now supports **100+ providers** (4 Free + 8 OAuth + 91 API Key + Custom compatible) - **Global Email Privacy Toggle:** Added a persistent eye-icon toggle button across all dashboard pages (Providers, Usage Limits, Playground) that reveals or hides masked email addresses. Toggle state is stored in localStorage and synced globally via Zustand store - **Documentation Refresh:** Updated README, ARCHITECTURE, FEATURES, AGENTS.md, and API_REFERENCE for v3.6.2 with accurate provider counts (100+), new executor list, and system API documentation -- **Uninstall Guide:** Created comprehensive `docs/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) +- **Uninstall Guide:** Created comprehensive `docs/guides/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) ### 🐛 Bug Fixes diff --git a/docs/i18n/bn/CONTRIBUTING.md b/docs/i18n/bn/CONTRIBUTING.md index c1b2e77012..94f31022e0 100644 --- a/docs/i18n/bn/CONTRIBUTING.md +++ b/docs/i18n/bn/CONTRIBUTING.md @@ -153,7 +153,7 @@ Coverage notes: - If a PR changes production code in `src/`, `open-sse/`, `electron/`, or `bin/`, it must add or update automated tests in the same PR - `npm run coverage:report` prints the detailed file-by-file report from the latest coverage run - `npm run test:coverage:legacy` preserves the older metric for historical comparison -- See `docs/COVERAGE_PLAN.md` for the phased coverage improvement roadmap +- See `docs/ops/COVERAGE_PLAN.md` for the phased coverage improvement roadmap ### Pull Request Requirements @@ -305,7 +305,7 @@ Releases are managed via the `/generate-release` workflow. When a new GitHub Rel ## Getting Help -- **Architecture**: See [`docs/ARCHITECTURE.md`](docs/ARCHITECTURE.md) -- **API Reference**: See [`docs/API_REFERENCE.md`](docs/API_REFERENCE.md) +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](docs/architecture/ARCHITECTURE.md) +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](docs/reference/API_REFERENCE.md) - **Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) - **ADRs**: See `docs/adr/` for architectural decision records diff --git a/docs/i18n/bn/README.md b/docs/i18n/bn/README.md index bc77d9bbcf..af9bdf9703 100644 --- a/docs/i18n/bn/README.md +++ b/docs/i18n/bn/README.md @@ -2267,25 +2267,25 @@ Se não quiser criar credenciais próprias agora, ainda é possível usar o flux ## Documentación -| Document | Description | -| -------------------------------------------------------- | --------------------------------------------------- | -| [User Guide](docs/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | -| [API Reference](docs/API_REFERENCE.md) | All endpoints with examples | -| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | -| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | -| [Auto-Combo Engine](docs/auto-combo.md) | 6-factor scoring, mode packs, self-healing | -| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | -| [Troubleshooting](docs/TROUBLESHOOTING.md) | Common problems and solutions | -| [Architecture](docs/ARCHITECTURE.md) | System architecture and internals | -| [Codebase Documentation](docs/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | -| [Uninstall Guide](docs/UNINSTALL.md) | Clean removal for all install methods | -| [Environment Config](docs/ENVIRONMENT.md) | Complete `.env` variables and references | -| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | -| [OpenAPI Spec](docs/openapi.yaml) | OpenAPI 3.0 specification | -| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | -| [VM Deployment](docs/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | -| [Features Gallery](docs/FEATURES.md) | Visual dashboard tour with screenshots | -| [Release Checklist](docs/RELEASE_CHECKLIST.md) | Pre-release validation steps | +| Document | Description | +| --------------------------------------------------------------------- | --------------------------------------------------- | +| [User Guide](docs/guides/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | +| [API Reference](docs/reference/API_REFERENCE.md) | All endpoints with examples | +| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | +| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | +| [Auto-Combo Engine](docs/auto-combo.md) | 6-factor scoring, mode packs, self-healing | +| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | +| [Troubleshooting](docs/guides/TROUBLESHOOTING.md) | Common problems and solutions | +| [Architecture](docs/architecture/ARCHITECTURE.md) | System architecture and internals | +| [Codebase Documentation](docs/architecture/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | +| [Uninstall Guide](docs/guides/UNINSTALL.md) | Clean removal for all install methods | +| [Environment Config](docs/reference/ENVIRONMENT.md) | Complete `.env` variables and references | +| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | +| [OpenAPI Spec](docs/reference/openapi.yaml) | OpenAPI 3.0 specification | +| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | +| [VM Deployment](docs/ops/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | +| [Features Gallery](docs/guides/FEATURES.md) | Visual dashboard tour with screenshots | +| [Release Checklist](docs/ops/RELEASE_CHECKLIST.md) | Pre-release validation steps | --- diff --git a/docs/i18n/bn/docs/ARCHITECTURE.md b/docs/i18n/bn/docs/architecture/ARCHITECTURE.md similarity index 100% rename from docs/i18n/bn/docs/ARCHITECTURE.md rename to docs/i18n/bn/docs/architecture/ARCHITECTURE.md diff --git a/docs/i18n/bn/docs/CODEBASE_DOCUMENTATION.md b/docs/i18n/bn/docs/architecture/CODEBASE_DOCUMENTATION.md similarity index 100% rename from docs/i18n/bn/docs/CODEBASE_DOCUMENTATION.md rename to docs/i18n/bn/docs/architecture/CODEBASE_DOCUMENTATION.md diff --git a/docs/i18n/bn/docs/A2A-SERVER.md b/docs/i18n/bn/docs/frameworks/A2A-SERVER.md similarity index 100% rename from docs/i18n/bn/docs/A2A-SERVER.md rename to docs/i18n/bn/docs/frameworks/A2A-SERVER.md diff --git a/docs/i18n/bn/docs/MCP-SERVER.md b/docs/i18n/bn/docs/frameworks/MCP-SERVER.md similarity index 100% rename from docs/i18n/bn/docs/MCP-SERVER.md rename to docs/i18n/bn/docs/frameworks/MCP-SERVER.md diff --git a/docs/i18n/bn/docs/FEATURES.md b/docs/i18n/bn/docs/guides/FEATURES.md similarity index 100% rename from docs/i18n/bn/docs/FEATURES.md rename to docs/i18n/bn/docs/guides/FEATURES.md diff --git a/docs/i18n/bn/docs/I18N.md b/docs/i18n/bn/docs/guides/I18N.md similarity index 99% rename from docs/i18n/bn/docs/I18N.md rename to docs/i18n/bn/docs/guides/I18N.md index 0bfd210478..f1a5ad5def 100644 --- a/docs/i18n/bn/docs/I18N.md +++ b/docs/i18n/bn/docs/guides/I18N.md @@ -420,7 +420,7 @@ The generator originally used `code: "in"` (deprecated Google Translate code) fo ### `docs/i18n/README.md` Is Auto-Generated -The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/I18N.md` (this file) for hand-written documentation that should persist. +The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/guides/I18N.md` (this file) for hand-written documentation that should persist. ### External Untranslatable Keys List diff --git a/docs/i18n/bn/docs/TROUBLESHOOTING.md b/docs/i18n/bn/docs/guides/TROUBLESHOOTING.md similarity index 98% rename from docs/i18n/bn/docs/TROUBLESHOOTING.md rename to docs/i18n/bn/docs/guides/TROUBLESHOOTING.md index 93e367deb6..e1d40bff3f 100644 --- a/docs/i18n/bn/docs/TROUBLESHOOTING.md +++ b/docs/i18n/bn/docs/guides/TROUBLESHOOTING.md @@ -335,7 +335,7 @@ You can ignore this section if you do not run RAG or agent pipelines behind Omni ## Still Stuck? - **GitHub Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) -- **Architecture**: See [`docs/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details -- **API Reference**: See [`docs/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints - **Health Dashboard**: Check **Dashboard → Health** for real-time system status - **Translator**: Use **Dashboard → Translator** to debug format issues diff --git a/docs/i18n/bn/docs/UNINSTALL.md b/docs/i18n/bn/docs/guides/UNINSTALL.md similarity index 100% rename from docs/i18n/bn/docs/UNINSTALL.md rename to docs/i18n/bn/docs/guides/UNINSTALL.md diff --git a/docs/i18n/bn/docs/USER_GUIDE.md b/docs/i18n/bn/docs/guides/USER_GUIDE.md similarity index 100% rename from docs/i18n/bn/docs/USER_GUIDE.md rename to docs/i18n/bn/docs/guides/USER_GUIDE.md diff --git a/docs/i18n/bn/docs/COVERAGE_PLAN.md b/docs/i18n/bn/docs/ops/COVERAGE_PLAN.md similarity index 100% rename from docs/i18n/bn/docs/COVERAGE_PLAN.md rename to docs/i18n/bn/docs/ops/COVERAGE_PLAN.md diff --git a/docs/i18n/bn/docs/FLY_IO_DEPLOYMENT_GUIDE.md b/docs/i18n/bn/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/bn/docs/FLY_IO_DEPLOYMENT_GUIDE.md rename to docs/i18n/bn/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/bn/docs/RELEASE_CHECKLIST.md b/docs/i18n/bn/docs/ops/RELEASE_CHECKLIST.md similarity index 94% rename from docs/i18n/bn/docs/RELEASE_CHECKLIST.md rename to docs/i18n/bn/docs/ops/RELEASE_CHECKLIST.md index 035f637fb9..adc8b94d58 100644 --- a/docs/i18n/bn/docs/RELEASE_CHECKLIST.md +++ b/docs/i18n/bn/docs/ops/RELEASE_CHECKLIST.md @@ -16,14 +16,14 @@ Use this checklist before tagging or publishing a new OmniRoute release. ## API Docs -1. Update `docs/openapi.yaml`: +1. Update `docs/reference/openapi.yaml`: - `info.version` must equal `package.json` version. 2. Validate endpoint examples if API contracts changed. ## Runtime Docs -1. Review `docs/ARCHITECTURE.md` for storage/runtime drift. -2. Review `docs/TROUBLESHOOTING.md` for env var and operational drift. +1. Review `docs/architecture/ARCHITECTURE.md` for storage/runtime drift. +2. Review `docs/guides/TROUBLESHOOTING.md` for env var and operational drift. 3. Verify the release/runtime Node.js version still satisfies the supported secure floor: - `>=20.20.2 <21` or `>=22.22.2 <23` - `npm run check:node-runtime` diff --git a/docs/i18n/bn/docs/VM_DEPLOYMENT_GUIDE.md b/docs/i18n/bn/docs/ops/VM_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/bn/docs/VM_DEPLOYMENT_GUIDE.md rename to docs/i18n/bn/docs/ops/VM_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/bn/docs/API_REFERENCE.md b/docs/i18n/bn/docs/reference/API_REFERENCE.md similarity index 100% rename from docs/i18n/bn/docs/API_REFERENCE.md rename to docs/i18n/bn/docs/reference/API_REFERENCE.md diff --git a/docs/i18n/bn/docs/CLI-TOOLS.md b/docs/i18n/bn/docs/reference/CLI-TOOLS.md similarity index 100% rename from docs/i18n/bn/docs/CLI-TOOLS.md rename to docs/i18n/bn/docs/reference/CLI-TOOLS.md diff --git a/docs/i18n/bn/docs/ENVIRONMENT.md b/docs/i18n/bn/docs/reference/ENVIRONMENT.md similarity index 100% rename from docs/i18n/bn/docs/ENVIRONMENT.md rename to docs/i18n/bn/docs/reference/ENVIRONMENT.md diff --git a/docs/i18n/bn/docs/AUTO-COMBO.md b/docs/i18n/bn/docs/routing/AUTO-COMBO.md similarity index 100% rename from docs/i18n/bn/docs/AUTO-COMBO.md rename to docs/i18n/bn/docs/routing/AUTO-COMBO.md diff --git a/docs/i18n/bn/llm.txt b/docs/i18n/bn/llm.txt index 3e3a618682..5390b06bf3 100644 --- a/docs/i18n/bn/llm.txt +++ b/docs/i18n/bn/llm.txt @@ -357,11 +357,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### MCP Server (37 Tools) | Category | Tools | |------------|-------| -| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/MCP-SERVER.md` for full inventory) | +| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/frameworks/MCP-SERVER.md` for full inventory) | | Memory (3) | `memory_search`, `memory_add`, `memory_clear` | | Skills (4) | `skills_list`, `skills_enable`, `skills_execute`, `skills_executions` | -**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/MCP-SERVER.md`. +**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/frameworks/MCP-SERVER.md`. ### Provider Categories @@ -472,7 +472,7 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo 20. **Guardrails framework** in `src/lib/guardrails/` — hot-reloadable registry. Built-ins (priority-ordered): `vision-bridge` (5) → `pii-masker` (10) → `prompt-injection` (20). Fail-open model: exceptions never block traffic. Per-request opt-out via `x-omniroute-disabled-guardrails` header. -21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/AUTHZ_GUIDE.md`. +21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/architecture/AUTHZ_GUIDE.md`. 22. **Three resilience layers** are distinct (do not conflate them): - **Provider Circuit Breaker** (`src/shared/utils/circuitBreaker.ts`) — whole-provider scope. @@ -489,11 +489,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo - **MCP server expanded to 37 tools** (30 base + 3 memory + 4 skills) across ~13 scopes - **OAuth providers expanded to 14**: added Qwen, Kiro, Qoder, Gemini, Windsurf, GitLab Duo - **Coverage gate raised to 75/75/75/70** (was 60% across the board) — measured ~82% -- **Reasoning replay** (`docs/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams +- **Reasoning replay** (`docs/routing/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams - **Compliance + Evals + Webhooks** documentation introduced -- **Stealth guide** (`docs/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration -- **Tunnels guide** (`docs/TUNNELS_GUIDE.md`) — Cloudflare tunnel management -- **Electron guide** (`docs/ELECTRON_GUIDE.md`) — desktop app build + signing +- **Stealth guide** (`docs/security/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration +- **Tunnels guide** (`docs/ops/TUNNELS_GUIDE.md`) — Cloudflare tunnel management +- **Electron guide** (`docs/guides/ELECTRON_GUIDE.md`) — desktop app build + signing ## Links @@ -505,11 +505,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### Documentation Index -- **Architecture & Reference**: `docs/ARCHITECTURE.md`, `docs/CODEBASE_DOCUMENTATION.md`, `docs/REPOSITORY_MAP.md`, `docs/API_REFERENCE.md`, `docs/PROVIDER_REFERENCE.md`, `docs/openapi.yaml` -- **Operator guides**: `docs/USER_GUIDE.md`, `docs/CLI-TOOLS.md`, `docs/TROUBLESHOOTING.md`, `docs/COVERAGE_PLAN.md` -- **Protocols**: `docs/MCP-SERVER.md`, `docs/A2A-SERVER.md`, `docs/AGENT_PROTOCOLS_GUIDE.md`, `docs/CLOUD_AGENT.md` -- **Routing & resilience**: `docs/AUTO-COMBO.md`, `docs/RESILIENCE_GUIDE.md` -- **Security**: `docs/AUTHZ_GUIDE.md`, `docs/GUARDRAILS.md`, `docs/COMPLIANCE.md`, `docs/STEALTH_GUIDE.md` -- **Extensibility**: `docs/SKILLS.md`, `docs/MEMORY.md`, `docs/EVALS.md`, `docs/WEBHOOKS.md`, `docs/REASONING_REPLAY.md` -- **Platform**: `docs/ELECTRON_GUIDE.md`, `docs/TUNNELS_GUIDE.md` +- **Architecture & Reference**: `docs/architecture/ARCHITECTURE.md`, `docs/architecture/CODEBASE_DOCUMENTATION.md`, `docs/architecture/REPOSITORY_MAP.md`, `docs/reference/API_REFERENCE.md`, `docs/reference/PROVIDER_REFERENCE.md`, `docs/reference/openapi.yaml` +- **Operator guides**: `docs/guides/USER_GUIDE.md`, `docs/reference/CLI-TOOLS.md`, `docs/guides/TROUBLESHOOTING.md`, `docs/ops/COVERAGE_PLAN.md` +- **Protocols**: `docs/frameworks/MCP-SERVER.md`, `docs/frameworks/A2A-SERVER.md`, `docs/frameworks/AGENT_PROTOCOLS_GUIDE.md`, `docs/frameworks/CLOUD_AGENT.md` +- **Routing & resilience**: `docs/routing/AUTO-COMBO.md`, `docs/architecture/RESILIENCE_GUIDE.md` +- **Security**: `docs/architecture/AUTHZ_GUIDE.md`, `docs/security/GUARDRAILS.md`, `docs/security/COMPLIANCE.md`, `docs/security/STEALTH_GUIDE.md` +- **Extensibility**: `docs/frameworks/SKILLS.md`, `docs/frameworks/MEMORY.md`, `docs/frameworks/EVALS.md`, `docs/frameworks/WEBHOOKS.md`, `docs/routing/REASONING_REPLAY.md` +- **Platform**: `docs/guides/ELECTRON_GUIDE.md`, `docs/ops/TUNNELS_GUIDE.md` - **AI agents**: `CLAUDE.md`, `AGENTS.md`, `GEMINI.md` diff --git a/docs/i18n/cs/CHANGELOG.md b/docs/i18n/cs/CHANGELOG.md index 81f60f41a1..66d6e4d36e 100644 --- a/docs/i18n/cs/CHANGELOG.md +++ b/docs/i18n/cs/CHANGELOG.md @@ -1310,7 +1310,7 @@ We identified that **155 community PRs** across the entire project history (from - **33 New API Key Providers:** Massive provider expansion adding DeepInfra, Vercel AI Gateway, Lambda AI, SambaNova, nScale, OVHcloud AI, Baseten, PublicAI, Moonshot AI, Meta Llama API, v0 (Vercel), Morph, Featherless AI, FriendliAI, LlamaGate, Galadriel, Weights & Biases Inference, Volcengine, AI21 Labs, Venice.ai, Codestral, Upstage, Maritalk, Xiaomi MiMo, Inference.net, NanoGPT, Predibase, Bytez, Heroku AI, Databricks, Snowflake Cortex, and GigaChat (Sber). OmniRoute now supports **100+ providers** (4 Free + 8 OAuth + 91 API Key + Custom compatible) - **Global Email Privacy Toggle:** Added a persistent eye-icon toggle button across all dashboard pages (Providers, Usage Limits, Playground) that reveals or hides masked email addresses. Toggle state is stored in localStorage and synced globally via Zustand store - **Documentation Refresh:** Updated README, ARCHITECTURE, FEATURES, AGENTS.md, and API_REFERENCE for v3.6.2 with accurate provider counts (100+), new executor list, and system API documentation -- **Uninstall Guide:** Created comprehensive `docs/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) +- **Uninstall Guide:** Created comprehensive `docs/guides/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) ### 🐛 Bug Fixes diff --git a/docs/i18n/cs/CONTRIBUTING.md b/docs/i18n/cs/CONTRIBUTING.md index 1621756f93..1f739e5a3c 100644 --- a/docs/i18n/cs/CONTRIBUTING.md +++ b/docs/i18n/cs/CONTRIBUTING.md @@ -153,7 +153,7 @@ Coverage notes: - If a PR changes production code in `src/`, `open-sse/`, `electron/`, or `bin/`, it must add or update automated tests in the same PR - `npm run coverage:report` prints the detailed file-by-file report from the latest coverage run - `npm run test:coverage:legacy` preserves the older metric for historical comparison -- See `docs/COVERAGE_PLAN.md` for the phased coverage improvement roadmap +- See `docs/ops/COVERAGE_PLAN.md` for the phased coverage improvement roadmap ### Pull Request Requirements @@ -305,7 +305,7 @@ Releases are managed via the `/generate-release` workflow. When a new GitHub Rel ## Getting Help -- **Architecture**: See [`docs/ARCHITECTURE.md`](docs/ARCHITECTURE.md) -- **API Reference**: See [`docs/API_REFERENCE.md`](docs/API_REFERENCE.md) +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](docs/architecture/ARCHITECTURE.md) +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](docs/reference/API_REFERENCE.md) - **Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) - **ADRs**: See `docs/adr/` for architectural decision records diff --git a/docs/i18n/cs/README.md b/docs/i18n/cs/README.md index 50f1ba2567..4595656fe9 100644 --- a/docs/i18n/cs/README.md +++ b/docs/i18n/cs/README.md @@ -2267,25 +2267,25 @@ Se não quiser criar credenciais próprias agora, ainda é possível usar o flux ## Dokumentace -| Document | Description | -| -------------------------------------------------------- | --------------------------------------------------- | -| [User Guide](docs/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | -| [API Reference](docs/API_REFERENCE.md) | All endpoints with examples | -| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | -| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | -| [Auto-Combo Engine](docs/AUTO-COMBO.md) | 6-factor scoring, mode packs, self-healing | -| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | -| [Troubleshooting](docs/TROUBLESHOOTING.md) | Common problems and solutions | -| [Architecture](docs/ARCHITECTURE.md) | System architecture and internals | -| [Codebase Documentation](docs/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | -| [Uninstall Guide](docs/UNINSTALL.md) | Clean removal for all install methods | -| [Environment Config](docs/ENVIRONMENT.md) | Complete `.env` variables and references | -| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | -| [OpenAPI Spec](docs/openapi.yaml) | OpenAPI 3.0 specification | -| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | -| [VM Deployment](docs/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | -| [Features Gallery](docs/FEATURES.md) | Visual dashboard tour with screenshots | -| [Release Checklist](docs/RELEASE_CHECKLIST.md) | Pre-release validation steps | +| Document | Description | +| --------------------------------------------------------------------- | --------------------------------------------------- | +| [User Guide](docs/guides/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | +| [API Reference](docs/reference/API_REFERENCE.md) | All endpoints with examples | +| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | +| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | +| [Auto-Combo Engine](docs/routing/AUTO-COMBO.md) | 6-factor scoring, mode packs, self-healing | +| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | +| [Troubleshooting](docs/guides/TROUBLESHOOTING.md) | Common problems and solutions | +| [Architecture](docs/architecture/ARCHITECTURE.md) | System architecture and internals | +| [Codebase Documentation](docs/architecture/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | +| [Uninstall Guide](docs/guides/UNINSTALL.md) | Clean removal for all install methods | +| [Environment Config](docs/reference/ENVIRONMENT.md) | Complete `.env` variables and references | +| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | +| [OpenAPI Spec](docs/reference/openapi.yaml) | OpenAPI 3.0 specification | +| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | +| [VM Deployment](docs/ops/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | +| [Features Gallery](docs/guides/FEATURES.md) | Visual dashboard tour with screenshots | +| [Release Checklist](docs/ops/RELEASE_CHECKLIST.md) | Pre-release validation steps | --- diff --git a/docs/i18n/cs/docs/ARCHITECTURE.md b/docs/i18n/cs/docs/architecture/ARCHITECTURE.md similarity index 100% rename from docs/i18n/cs/docs/ARCHITECTURE.md rename to docs/i18n/cs/docs/architecture/ARCHITECTURE.md diff --git a/docs/i18n/cs/docs/CODEBASE_DOCUMENTATION.md b/docs/i18n/cs/docs/architecture/CODEBASE_DOCUMENTATION.md similarity index 100% rename from docs/i18n/cs/docs/CODEBASE_DOCUMENTATION.md rename to docs/i18n/cs/docs/architecture/CODEBASE_DOCUMENTATION.md diff --git a/docs/i18n/cs/docs/A2A-SERVER.md b/docs/i18n/cs/docs/frameworks/A2A-SERVER.md similarity index 100% rename from docs/i18n/cs/docs/A2A-SERVER.md rename to docs/i18n/cs/docs/frameworks/A2A-SERVER.md diff --git a/docs/i18n/cs/docs/MCP-SERVER.md b/docs/i18n/cs/docs/frameworks/MCP-SERVER.md similarity index 100% rename from docs/i18n/cs/docs/MCP-SERVER.md rename to docs/i18n/cs/docs/frameworks/MCP-SERVER.md diff --git a/docs/i18n/cs/docs/FEATURES.md b/docs/i18n/cs/docs/guides/FEATURES.md similarity index 100% rename from docs/i18n/cs/docs/FEATURES.md rename to docs/i18n/cs/docs/guides/FEATURES.md diff --git a/docs/i18n/cs/docs/I18N.md b/docs/i18n/cs/docs/guides/I18N.md similarity index 99% rename from docs/i18n/cs/docs/I18N.md rename to docs/i18n/cs/docs/guides/I18N.md index 3a15f4f051..ccf62650b5 100644 --- a/docs/i18n/cs/docs/I18N.md +++ b/docs/i18n/cs/docs/guides/I18N.md @@ -420,7 +420,7 @@ The generator originally used `code: "in"` (deprecated Google Translate code) fo ### `docs/i18n/README.md` Is Auto-Generated -The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/I18N.md` (this file) for hand-written documentation that should persist. +The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/guides/I18N.md` (this file) for hand-written documentation that should persist. ### External Untranslatable Keys List diff --git a/docs/i18n/cs/docs/TROUBLESHOOTING.md b/docs/i18n/cs/docs/guides/TROUBLESHOOTING.md similarity index 98% rename from docs/i18n/cs/docs/TROUBLESHOOTING.md rename to docs/i18n/cs/docs/guides/TROUBLESHOOTING.md index 7846a571e7..d4562b2259 100644 --- a/docs/i18n/cs/docs/TROUBLESHOOTING.md +++ b/docs/i18n/cs/docs/guides/TROUBLESHOOTING.md @@ -335,7 +335,7 @@ You can ignore this section if you do not run RAG or agent pipelines behind Omni ## Still Stuck? - **GitHub Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) -- **Architecture**: See [`docs/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details -- **API Reference**: See [`docs/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints - **Health Dashboard**: Check **Dashboard → Health** for real-time system status - **Translator**: Use **Dashboard → Translator** to debug format issues diff --git a/docs/i18n/cs/docs/UNINSTALL.md b/docs/i18n/cs/docs/guides/UNINSTALL.md similarity index 100% rename from docs/i18n/cs/docs/UNINSTALL.md rename to docs/i18n/cs/docs/guides/UNINSTALL.md diff --git a/docs/i18n/cs/docs/USER_GUIDE.md b/docs/i18n/cs/docs/guides/USER_GUIDE.md similarity index 100% rename from docs/i18n/cs/docs/USER_GUIDE.md rename to docs/i18n/cs/docs/guides/USER_GUIDE.md diff --git a/docs/i18n/cs/docs/COVERAGE_PLAN.md b/docs/i18n/cs/docs/ops/COVERAGE_PLAN.md similarity index 100% rename from docs/i18n/cs/docs/COVERAGE_PLAN.md rename to docs/i18n/cs/docs/ops/COVERAGE_PLAN.md diff --git a/docs/i18n/cs/docs/FLY_IO_DEPLOYMENT_GUIDE.md b/docs/i18n/cs/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/cs/docs/FLY_IO_DEPLOYMENT_GUIDE.md rename to docs/i18n/cs/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/cs/docs/RELEASE_CHECKLIST.md b/docs/i18n/cs/docs/ops/RELEASE_CHECKLIST.md similarity index 94% rename from docs/i18n/cs/docs/RELEASE_CHECKLIST.md rename to docs/i18n/cs/docs/ops/RELEASE_CHECKLIST.md index 3357cc9ff7..6c09e74932 100644 --- a/docs/i18n/cs/docs/RELEASE_CHECKLIST.md +++ b/docs/i18n/cs/docs/ops/RELEASE_CHECKLIST.md @@ -16,14 +16,14 @@ Use this checklist before tagging or publishing a new OmniRoute release. ## API Docs -1. Update `docs/openapi.yaml`: +1. Update `docs/reference/openapi.yaml`: - `info.version` must equal `package.json` version. 2. Validate endpoint examples if API contracts changed. ## Runtime Docs -1. Review `docs/ARCHITECTURE.md` for storage/runtime drift. -2. Review `docs/TROUBLESHOOTING.md` for env var and operational drift. +1. Review `docs/architecture/ARCHITECTURE.md` for storage/runtime drift. +2. Review `docs/guides/TROUBLESHOOTING.md` for env var and operational drift. 3. Verify the release/runtime Node.js version still satisfies the supported secure floor: - `>=20.20.2 <21` or `>=22.22.2 <23` - `npm run check:node-runtime` diff --git a/docs/i18n/cs/docs/VM_DEPLOYMENT_GUIDE.md b/docs/i18n/cs/docs/ops/VM_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/cs/docs/VM_DEPLOYMENT_GUIDE.md rename to docs/i18n/cs/docs/ops/VM_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/cs/docs/API_REFERENCE.md b/docs/i18n/cs/docs/reference/API_REFERENCE.md similarity index 100% rename from docs/i18n/cs/docs/API_REFERENCE.md rename to docs/i18n/cs/docs/reference/API_REFERENCE.md diff --git a/docs/i18n/cs/docs/CLI-TOOLS.md b/docs/i18n/cs/docs/reference/CLI-TOOLS.md similarity index 100% rename from docs/i18n/cs/docs/CLI-TOOLS.md rename to docs/i18n/cs/docs/reference/CLI-TOOLS.md diff --git a/docs/i18n/cs/docs/ENVIRONMENT.md b/docs/i18n/cs/docs/reference/ENVIRONMENT.md similarity index 100% rename from docs/i18n/cs/docs/ENVIRONMENT.md rename to docs/i18n/cs/docs/reference/ENVIRONMENT.md diff --git a/docs/i18n/cs/docs/AUTO-COMBO.md b/docs/i18n/cs/docs/routing/AUTO-COMBO.md similarity index 100% rename from docs/i18n/cs/docs/AUTO-COMBO.md rename to docs/i18n/cs/docs/routing/AUTO-COMBO.md diff --git a/docs/i18n/cs/llm.txt b/docs/i18n/cs/llm.txt index d75cfb0f73..7c1d81ff91 100644 --- a/docs/i18n/cs/llm.txt +++ b/docs/i18n/cs/llm.txt @@ -357,11 +357,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### MCP Server (37 Tools) | Category | Tools | |------------|-------| -| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/MCP-SERVER.md` for full inventory) | +| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/frameworks/MCP-SERVER.md` for full inventory) | | Memory (3) | `memory_search`, `memory_add`, `memory_clear` | | Skills (4) | `skills_list`, `skills_enable`, `skills_execute`, `skills_executions` | -**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/MCP-SERVER.md`. +**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/frameworks/MCP-SERVER.md`. ### Provider Categories @@ -472,7 +472,7 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo 20. **Guardrails framework** in `src/lib/guardrails/` — hot-reloadable registry. Built-ins (priority-ordered): `vision-bridge` (5) → `pii-masker` (10) → `prompt-injection` (20). Fail-open model: exceptions never block traffic. Per-request opt-out via `x-omniroute-disabled-guardrails` header. -21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/AUTHZ_GUIDE.md`. +21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/architecture/AUTHZ_GUIDE.md`. 22. **Three resilience layers** are distinct (do not conflate them): - **Provider Circuit Breaker** (`src/shared/utils/circuitBreaker.ts`) — whole-provider scope. @@ -489,11 +489,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo - **MCP server expanded to 37 tools** (30 base + 3 memory + 4 skills) across ~13 scopes - **OAuth providers expanded to 14**: added Qwen, Kiro, Qoder, Gemini, Windsurf, GitLab Duo - **Coverage gate raised to 75/75/75/70** (was 60% across the board) — measured ~82% -- **Reasoning replay** (`docs/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams +- **Reasoning replay** (`docs/routing/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams - **Compliance + Evals + Webhooks** documentation introduced -- **Stealth guide** (`docs/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration -- **Tunnels guide** (`docs/TUNNELS_GUIDE.md`) — Cloudflare tunnel management -- **Electron guide** (`docs/ELECTRON_GUIDE.md`) — desktop app build + signing +- **Stealth guide** (`docs/security/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration +- **Tunnels guide** (`docs/ops/TUNNELS_GUIDE.md`) — Cloudflare tunnel management +- **Electron guide** (`docs/guides/ELECTRON_GUIDE.md`) — desktop app build + signing ## Links @@ -505,11 +505,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### Documentation Index -- **Architecture & Reference**: `docs/ARCHITECTURE.md`, `docs/CODEBASE_DOCUMENTATION.md`, `docs/REPOSITORY_MAP.md`, `docs/API_REFERENCE.md`, `docs/PROVIDER_REFERENCE.md`, `docs/openapi.yaml` -- **Operator guides**: `docs/USER_GUIDE.md`, `docs/CLI-TOOLS.md`, `docs/TROUBLESHOOTING.md`, `docs/COVERAGE_PLAN.md` -- **Protocols**: `docs/MCP-SERVER.md`, `docs/A2A-SERVER.md`, `docs/AGENT_PROTOCOLS_GUIDE.md`, `docs/CLOUD_AGENT.md` -- **Routing & resilience**: `docs/AUTO-COMBO.md`, `docs/RESILIENCE_GUIDE.md` -- **Security**: `docs/AUTHZ_GUIDE.md`, `docs/GUARDRAILS.md`, `docs/COMPLIANCE.md`, `docs/STEALTH_GUIDE.md` -- **Extensibility**: `docs/SKILLS.md`, `docs/MEMORY.md`, `docs/EVALS.md`, `docs/WEBHOOKS.md`, `docs/REASONING_REPLAY.md` -- **Platform**: `docs/ELECTRON_GUIDE.md`, `docs/TUNNELS_GUIDE.md` +- **Architecture & Reference**: `docs/architecture/ARCHITECTURE.md`, `docs/architecture/CODEBASE_DOCUMENTATION.md`, `docs/architecture/REPOSITORY_MAP.md`, `docs/reference/API_REFERENCE.md`, `docs/reference/PROVIDER_REFERENCE.md`, `docs/reference/openapi.yaml` +- **Operator guides**: `docs/guides/USER_GUIDE.md`, `docs/reference/CLI-TOOLS.md`, `docs/guides/TROUBLESHOOTING.md`, `docs/ops/COVERAGE_PLAN.md` +- **Protocols**: `docs/frameworks/MCP-SERVER.md`, `docs/frameworks/A2A-SERVER.md`, `docs/frameworks/AGENT_PROTOCOLS_GUIDE.md`, `docs/frameworks/CLOUD_AGENT.md` +- **Routing & resilience**: `docs/routing/AUTO-COMBO.md`, `docs/architecture/RESILIENCE_GUIDE.md` +- **Security**: `docs/architecture/AUTHZ_GUIDE.md`, `docs/security/GUARDRAILS.md`, `docs/security/COMPLIANCE.md`, `docs/security/STEALTH_GUIDE.md` +- **Extensibility**: `docs/frameworks/SKILLS.md`, `docs/frameworks/MEMORY.md`, `docs/frameworks/EVALS.md`, `docs/frameworks/WEBHOOKS.md`, `docs/routing/REASONING_REPLAY.md` +- **Platform**: `docs/guides/ELECTRON_GUIDE.md`, `docs/ops/TUNNELS_GUIDE.md` - **AI agents**: `CLAUDE.md`, `AGENTS.md`, `GEMINI.md` diff --git a/docs/i18n/da/CHANGELOG.md b/docs/i18n/da/CHANGELOG.md index 9cf4b6a14a..3233dde285 100644 --- a/docs/i18n/da/CHANGELOG.md +++ b/docs/i18n/da/CHANGELOG.md @@ -1310,7 +1310,7 @@ We identified that **155 community PRs** across the entire project history (from - **33 New API Key Providers:** Massive provider expansion adding DeepInfra, Vercel AI Gateway, Lambda AI, SambaNova, nScale, OVHcloud AI, Baseten, PublicAI, Moonshot AI, Meta Llama API, v0 (Vercel), Morph, Featherless AI, FriendliAI, LlamaGate, Galadriel, Weights & Biases Inference, Volcengine, AI21 Labs, Venice.ai, Codestral, Upstage, Maritalk, Xiaomi MiMo, Inference.net, NanoGPT, Predibase, Bytez, Heroku AI, Databricks, Snowflake Cortex, and GigaChat (Sber). OmniRoute now supports **100+ providers** (4 Free + 8 OAuth + 91 API Key + Custom compatible) - **Global Email Privacy Toggle:** Added a persistent eye-icon toggle button across all dashboard pages (Providers, Usage Limits, Playground) that reveals or hides masked email addresses. Toggle state is stored in localStorage and synced globally via Zustand store - **Documentation Refresh:** Updated README, ARCHITECTURE, FEATURES, AGENTS.md, and API_REFERENCE for v3.6.2 with accurate provider counts (100+), new executor list, and system API documentation -- **Uninstall Guide:** Created comprehensive `docs/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) +- **Uninstall Guide:** Created comprehensive `docs/guides/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) ### 🐛 Bug Fixes diff --git a/docs/i18n/da/CONTRIBUTING.md b/docs/i18n/da/CONTRIBUTING.md index d70bd4813a..4b27f5e962 100644 --- a/docs/i18n/da/CONTRIBUTING.md +++ b/docs/i18n/da/CONTRIBUTING.md @@ -153,7 +153,7 @@ Coverage notes: - If a PR changes production code in `src/`, `open-sse/`, `electron/`, or `bin/`, it must add or update automated tests in the same PR - `npm run coverage:report` prints the detailed file-by-file report from the latest coverage run - `npm run test:coverage:legacy` preserves the older metric for historical comparison -- See `docs/COVERAGE_PLAN.md` for the phased coverage improvement roadmap +- See `docs/ops/COVERAGE_PLAN.md` for the phased coverage improvement roadmap ### Pull Request Requirements @@ -305,7 +305,7 @@ Releases are managed via the `/generate-release` workflow. When a new GitHub Rel ## Getting Help -- **Architecture**: See [`docs/ARCHITECTURE.md`](docs/ARCHITECTURE.md) -- **API Reference**: See [`docs/API_REFERENCE.md`](docs/API_REFERENCE.md) +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](docs/architecture/ARCHITECTURE.md) +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](docs/reference/API_REFERENCE.md) - **Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) - **ADRs**: See `docs/adr/` for architectural decision records diff --git a/docs/i18n/da/README.md b/docs/i18n/da/README.md index 9a88f9af24..39f75a1bf7 100644 --- a/docs/i18n/da/README.md +++ b/docs/i18n/da/README.md @@ -2267,25 +2267,25 @@ Se não quiser criar credenciais próprias agora, ainda é possível usar o flux ## Dokumentation -| Document | Description | -| -------------------------------------------------------- | --------------------------------------------------- | -| [User Guide](docs/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | -| [API Reference](docs/API_REFERENCE.md) | All endpoints with examples | -| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | -| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | -| [Auto-Combo Engine](docs/AUTO-COMBO.md) | 6-factor scoring, mode packs, self-healing | -| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | -| [Troubleshooting](docs/TROUBLESHOOTING.md) | Common problems and solutions | -| [Architecture](docs/ARCHITECTURE.md) | System architecture and internals | -| [Codebase Documentation](docs/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | -| [Uninstall Guide](docs/UNINSTALL.md) | Clean removal for all install methods | -| [Environment Config](docs/ENVIRONMENT.md) | Complete `.env` variables and references | -| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | -| [OpenAPI Spec](docs/openapi.yaml) | OpenAPI 3.0 specification | -| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | -| [VM Deployment](docs/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | -| [Features Gallery](docs/FEATURES.md) | Visual dashboard tour with screenshots | -| [Release Checklist](docs/RELEASE_CHECKLIST.md) | Pre-release validation steps | +| Document | Description | +| --------------------------------------------------------------------- | --------------------------------------------------- | +| [User Guide](docs/guides/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | +| [API Reference](docs/reference/API_REFERENCE.md) | All endpoints with examples | +| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | +| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | +| [Auto-Combo Engine](docs/routing/AUTO-COMBO.md) | 6-factor scoring, mode packs, self-healing | +| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | +| [Troubleshooting](docs/guides/TROUBLESHOOTING.md) | Common problems and solutions | +| [Architecture](docs/architecture/ARCHITECTURE.md) | System architecture and internals | +| [Codebase Documentation](docs/architecture/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | +| [Uninstall Guide](docs/guides/UNINSTALL.md) | Clean removal for all install methods | +| [Environment Config](docs/reference/ENVIRONMENT.md) | Complete `.env` variables and references | +| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | +| [OpenAPI Spec](docs/reference/openapi.yaml) | OpenAPI 3.0 specification | +| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | +| [VM Deployment](docs/ops/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | +| [Features Gallery](docs/guides/FEATURES.md) | Visual dashboard tour with screenshots | +| [Release Checklist](docs/ops/RELEASE_CHECKLIST.md) | Pre-release validation steps | --- diff --git a/docs/i18n/da/docs/ARCHITECTURE.md b/docs/i18n/da/docs/architecture/ARCHITECTURE.md similarity index 100% rename from docs/i18n/da/docs/ARCHITECTURE.md rename to docs/i18n/da/docs/architecture/ARCHITECTURE.md diff --git a/docs/i18n/da/docs/CODEBASE_DOCUMENTATION.md b/docs/i18n/da/docs/architecture/CODEBASE_DOCUMENTATION.md similarity index 100% rename from docs/i18n/da/docs/CODEBASE_DOCUMENTATION.md rename to docs/i18n/da/docs/architecture/CODEBASE_DOCUMENTATION.md diff --git a/docs/i18n/da/docs/A2A-SERVER.md b/docs/i18n/da/docs/frameworks/A2A-SERVER.md similarity index 100% rename from docs/i18n/da/docs/A2A-SERVER.md rename to docs/i18n/da/docs/frameworks/A2A-SERVER.md diff --git a/docs/i18n/da/docs/MCP-SERVER.md b/docs/i18n/da/docs/frameworks/MCP-SERVER.md similarity index 100% rename from docs/i18n/da/docs/MCP-SERVER.md rename to docs/i18n/da/docs/frameworks/MCP-SERVER.md diff --git a/docs/i18n/da/docs/FEATURES.md b/docs/i18n/da/docs/guides/FEATURES.md similarity index 100% rename from docs/i18n/da/docs/FEATURES.md rename to docs/i18n/da/docs/guides/FEATURES.md diff --git a/docs/i18n/da/docs/I18N.md b/docs/i18n/da/docs/guides/I18N.md similarity index 99% rename from docs/i18n/da/docs/I18N.md rename to docs/i18n/da/docs/guides/I18N.md index 506128beaf..54632fa3f3 100644 --- a/docs/i18n/da/docs/I18N.md +++ b/docs/i18n/da/docs/guides/I18N.md @@ -420,7 +420,7 @@ The generator originally used `code: "in"` (deprecated Google Translate code) fo ### `docs/i18n/README.md` Is Auto-Generated -The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/I18N.md` (this file) for hand-written documentation that should persist. +The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/guides/I18N.md` (this file) for hand-written documentation that should persist. ### External Untranslatable Keys List diff --git a/docs/i18n/da/docs/TROUBLESHOOTING.md b/docs/i18n/da/docs/guides/TROUBLESHOOTING.md similarity index 98% rename from docs/i18n/da/docs/TROUBLESHOOTING.md rename to docs/i18n/da/docs/guides/TROUBLESHOOTING.md index 28962ce9e6..82639d666e 100644 --- a/docs/i18n/da/docs/TROUBLESHOOTING.md +++ b/docs/i18n/da/docs/guides/TROUBLESHOOTING.md @@ -335,7 +335,7 @@ You can ignore this section if you do not run RAG or agent pipelines behind Omni ## Still Stuck? - **GitHub Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) -- **Architecture**: See [`docs/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details -- **API Reference**: See [`docs/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints - **Health Dashboard**: Check **Dashboard → Health** for real-time system status - **Translator**: Use **Dashboard → Translator** to debug format issues diff --git a/docs/i18n/da/docs/UNINSTALL.md b/docs/i18n/da/docs/guides/UNINSTALL.md similarity index 100% rename from docs/i18n/da/docs/UNINSTALL.md rename to docs/i18n/da/docs/guides/UNINSTALL.md diff --git a/docs/i18n/da/docs/USER_GUIDE.md b/docs/i18n/da/docs/guides/USER_GUIDE.md similarity index 100% rename from docs/i18n/da/docs/USER_GUIDE.md rename to docs/i18n/da/docs/guides/USER_GUIDE.md diff --git a/docs/i18n/da/docs/COVERAGE_PLAN.md b/docs/i18n/da/docs/ops/COVERAGE_PLAN.md similarity index 100% rename from docs/i18n/da/docs/COVERAGE_PLAN.md rename to docs/i18n/da/docs/ops/COVERAGE_PLAN.md diff --git a/docs/i18n/da/docs/FLY_IO_DEPLOYMENT_GUIDE.md b/docs/i18n/da/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/da/docs/FLY_IO_DEPLOYMENT_GUIDE.md rename to docs/i18n/da/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/da/docs/RELEASE_CHECKLIST.md b/docs/i18n/da/docs/ops/RELEASE_CHECKLIST.md similarity index 94% rename from docs/i18n/da/docs/RELEASE_CHECKLIST.md rename to docs/i18n/da/docs/ops/RELEASE_CHECKLIST.md index cff8961e27..8e07b36937 100644 --- a/docs/i18n/da/docs/RELEASE_CHECKLIST.md +++ b/docs/i18n/da/docs/ops/RELEASE_CHECKLIST.md @@ -16,14 +16,14 @@ Use this checklist before tagging or publishing a new OmniRoute release. ## API Docs -1. Update `docs/openapi.yaml`: +1. Update `docs/reference/openapi.yaml`: - `info.version` must equal `package.json` version. 2. Validate endpoint examples if API contracts changed. ## Runtime Docs -1. Review `docs/ARCHITECTURE.md` for storage/runtime drift. -2. Review `docs/TROUBLESHOOTING.md` for env var and operational drift. +1. Review `docs/architecture/ARCHITECTURE.md` for storage/runtime drift. +2. Review `docs/guides/TROUBLESHOOTING.md` for env var and operational drift. 3. Verify the release/runtime Node.js version still satisfies the supported secure floor: - `>=20.20.2 <21` or `>=22.22.2 <23` - `npm run check:node-runtime` diff --git a/docs/i18n/da/docs/VM_DEPLOYMENT_GUIDE.md b/docs/i18n/da/docs/ops/VM_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/da/docs/VM_DEPLOYMENT_GUIDE.md rename to docs/i18n/da/docs/ops/VM_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/da/docs/API_REFERENCE.md b/docs/i18n/da/docs/reference/API_REFERENCE.md similarity index 100% rename from docs/i18n/da/docs/API_REFERENCE.md rename to docs/i18n/da/docs/reference/API_REFERENCE.md diff --git a/docs/i18n/da/docs/CLI-TOOLS.md b/docs/i18n/da/docs/reference/CLI-TOOLS.md similarity index 100% rename from docs/i18n/da/docs/CLI-TOOLS.md rename to docs/i18n/da/docs/reference/CLI-TOOLS.md diff --git a/docs/i18n/da/docs/ENVIRONMENT.md b/docs/i18n/da/docs/reference/ENVIRONMENT.md similarity index 100% rename from docs/i18n/da/docs/ENVIRONMENT.md rename to docs/i18n/da/docs/reference/ENVIRONMENT.md diff --git a/docs/i18n/da/docs/AUTO-COMBO.md b/docs/i18n/da/docs/routing/AUTO-COMBO.md similarity index 100% rename from docs/i18n/da/docs/AUTO-COMBO.md rename to docs/i18n/da/docs/routing/AUTO-COMBO.md diff --git a/docs/i18n/da/llm.txt b/docs/i18n/da/llm.txt index ac343ef264..5b779adac3 100644 --- a/docs/i18n/da/llm.txt +++ b/docs/i18n/da/llm.txt @@ -357,11 +357,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### MCP Server (37 Tools) | Category | Tools | |------------|-------| -| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/MCP-SERVER.md` for full inventory) | +| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/frameworks/MCP-SERVER.md` for full inventory) | | Memory (3) | `memory_search`, `memory_add`, `memory_clear` | | Skills (4) | `skills_list`, `skills_enable`, `skills_execute`, `skills_executions` | -**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/MCP-SERVER.md`. +**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/frameworks/MCP-SERVER.md`. ### Provider Categories @@ -472,7 +472,7 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo 20. **Guardrails framework** in `src/lib/guardrails/` — hot-reloadable registry. Built-ins (priority-ordered): `vision-bridge` (5) → `pii-masker` (10) → `prompt-injection` (20). Fail-open model: exceptions never block traffic. Per-request opt-out via `x-omniroute-disabled-guardrails` header. -21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/AUTHZ_GUIDE.md`. +21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/architecture/AUTHZ_GUIDE.md`. 22. **Three resilience layers** are distinct (do not conflate them): - **Provider Circuit Breaker** (`src/shared/utils/circuitBreaker.ts`) — whole-provider scope. @@ -489,11 +489,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo - **MCP server expanded to 37 tools** (30 base + 3 memory + 4 skills) across ~13 scopes - **OAuth providers expanded to 14**: added Qwen, Kiro, Qoder, Gemini, Windsurf, GitLab Duo - **Coverage gate raised to 75/75/75/70** (was 60% across the board) — measured ~82% -- **Reasoning replay** (`docs/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams +- **Reasoning replay** (`docs/routing/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams - **Compliance + Evals + Webhooks** documentation introduced -- **Stealth guide** (`docs/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration -- **Tunnels guide** (`docs/TUNNELS_GUIDE.md`) — Cloudflare tunnel management -- **Electron guide** (`docs/ELECTRON_GUIDE.md`) — desktop app build + signing +- **Stealth guide** (`docs/security/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration +- **Tunnels guide** (`docs/ops/TUNNELS_GUIDE.md`) — Cloudflare tunnel management +- **Electron guide** (`docs/guides/ELECTRON_GUIDE.md`) — desktop app build + signing ## Links @@ -505,11 +505,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### Documentation Index -- **Architecture & Reference**: `docs/ARCHITECTURE.md`, `docs/CODEBASE_DOCUMENTATION.md`, `docs/REPOSITORY_MAP.md`, `docs/API_REFERENCE.md`, `docs/PROVIDER_REFERENCE.md`, `docs/openapi.yaml` -- **Operator guides**: `docs/USER_GUIDE.md`, `docs/CLI-TOOLS.md`, `docs/TROUBLESHOOTING.md`, `docs/COVERAGE_PLAN.md` -- **Protocols**: `docs/MCP-SERVER.md`, `docs/A2A-SERVER.md`, `docs/AGENT_PROTOCOLS_GUIDE.md`, `docs/CLOUD_AGENT.md` -- **Routing & resilience**: `docs/AUTO-COMBO.md`, `docs/RESILIENCE_GUIDE.md` -- **Security**: `docs/AUTHZ_GUIDE.md`, `docs/GUARDRAILS.md`, `docs/COMPLIANCE.md`, `docs/STEALTH_GUIDE.md` -- **Extensibility**: `docs/SKILLS.md`, `docs/MEMORY.md`, `docs/EVALS.md`, `docs/WEBHOOKS.md`, `docs/REASONING_REPLAY.md` -- **Platform**: `docs/ELECTRON_GUIDE.md`, `docs/TUNNELS_GUIDE.md` +- **Architecture & Reference**: `docs/architecture/ARCHITECTURE.md`, `docs/architecture/CODEBASE_DOCUMENTATION.md`, `docs/architecture/REPOSITORY_MAP.md`, `docs/reference/API_REFERENCE.md`, `docs/reference/PROVIDER_REFERENCE.md`, `docs/reference/openapi.yaml` +- **Operator guides**: `docs/guides/USER_GUIDE.md`, `docs/reference/CLI-TOOLS.md`, `docs/guides/TROUBLESHOOTING.md`, `docs/ops/COVERAGE_PLAN.md` +- **Protocols**: `docs/frameworks/MCP-SERVER.md`, `docs/frameworks/A2A-SERVER.md`, `docs/frameworks/AGENT_PROTOCOLS_GUIDE.md`, `docs/frameworks/CLOUD_AGENT.md` +- **Routing & resilience**: `docs/routing/AUTO-COMBO.md`, `docs/architecture/RESILIENCE_GUIDE.md` +- **Security**: `docs/architecture/AUTHZ_GUIDE.md`, `docs/security/GUARDRAILS.md`, `docs/security/COMPLIANCE.md`, `docs/security/STEALTH_GUIDE.md` +- **Extensibility**: `docs/frameworks/SKILLS.md`, `docs/frameworks/MEMORY.md`, `docs/frameworks/EVALS.md`, `docs/frameworks/WEBHOOKS.md`, `docs/routing/REASONING_REPLAY.md` +- **Platform**: `docs/guides/ELECTRON_GUIDE.md`, `docs/ops/TUNNELS_GUIDE.md` - **AI agents**: `CLAUDE.md`, `AGENTS.md`, `GEMINI.md` diff --git a/docs/i18n/de/CHANGELOG.md b/docs/i18n/de/CHANGELOG.md index 3ac010af16..3fe31391c0 100644 --- a/docs/i18n/de/CHANGELOG.md +++ b/docs/i18n/de/CHANGELOG.md @@ -1310,7 +1310,7 @@ We identified that **155 community PRs** across the entire project history (from - **33 New API Key Providers:** Massive provider expansion adding DeepInfra, Vercel AI Gateway, Lambda AI, SambaNova, nScale, OVHcloud AI, Baseten, PublicAI, Moonshot AI, Meta Llama API, v0 (Vercel), Morph, Featherless AI, FriendliAI, LlamaGate, Galadriel, Weights & Biases Inference, Volcengine, AI21 Labs, Venice.ai, Codestral, Upstage, Maritalk, Xiaomi MiMo, Inference.net, NanoGPT, Predibase, Bytez, Heroku AI, Databricks, Snowflake Cortex, and GigaChat (Sber). OmniRoute now supports **100+ providers** (4 Free + 8 OAuth + 91 API Key + Custom compatible) - **Global Email Privacy Toggle:** Added a persistent eye-icon toggle button across all dashboard pages (Providers, Usage Limits, Playground) that reveals or hides masked email addresses. Toggle state is stored in localStorage and synced globally via Zustand store - **Documentation Refresh:** Updated README, ARCHITECTURE, FEATURES, AGENTS.md, and API_REFERENCE for v3.6.2 with accurate provider counts (100+), new executor list, and system API documentation -- **Uninstall Guide:** Created comprehensive `docs/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) +- **Uninstall Guide:** Created comprehensive `docs/guides/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) ### 🐛 Bug Fixes diff --git a/docs/i18n/de/CONTRIBUTING.md b/docs/i18n/de/CONTRIBUTING.md index 5497d29106..37ed7ce173 100644 --- a/docs/i18n/de/CONTRIBUTING.md +++ b/docs/i18n/de/CONTRIBUTING.md @@ -153,7 +153,7 @@ Coverage notes: - If a PR changes production code in `src/`, `open-sse/`, `electron/`, or `bin/`, it must add or update automated tests in the same PR - `npm run coverage:report` prints the detailed file-by-file report from the latest coverage run - `npm run test:coverage:legacy` preserves the older metric for historical comparison -- See `docs/COVERAGE_PLAN.md` for the phased coverage improvement roadmap +- See `docs/ops/COVERAGE_PLAN.md` for the phased coverage improvement roadmap ### Pull Request Requirements @@ -305,7 +305,7 @@ Releases are managed via the `/generate-release` workflow. When a new GitHub Rel ## Getting Help -- **Architecture**: See [`docs/ARCHITECTURE.md`](docs/ARCHITECTURE.md) -- **API Reference**: See [`docs/API_REFERENCE.md`](docs/API_REFERENCE.md) +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](docs/architecture/ARCHITECTURE.md) +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](docs/reference/API_REFERENCE.md) - **Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) - **ADRs**: See `docs/adr/` for architectural decision records diff --git a/docs/i18n/de/README.md b/docs/i18n/de/README.md index 2db62bf6c2..6834c1de04 100644 --- a/docs/i18n/de/README.md +++ b/docs/i18n/de/README.md @@ -2267,25 +2267,25 @@ Se não quiser criar credenciais próprias agora, ainda é possível usar o flux ## Dokumentation -| Document | Description | -| -------------------------------------------------------- | --------------------------------------------------- | -| [User Guide](docs/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | -| [API Reference](docs/API_REFERENCE.md) | All endpoints with examples | -| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | -| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | -| [Auto-Combo Engine](docs/AUTO-COMBO.md) | 6-factor scoring, mode packs, self-healing | -| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | -| [Troubleshooting](docs/TROUBLESHOOTING.md) | Common problems and solutions | -| [Architecture](docs/ARCHITECTURE.md) | System architecture and internals | -| [Codebase Documentation](docs/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | -| [Uninstall Guide](docs/UNINSTALL.md) | Clean removal for all install methods | -| [Environment Config](docs/ENVIRONMENT.md) | Complete `.env` variables and references | -| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | -| [OpenAPI Spec](docs/openapi.yaml) | OpenAPI 3.0 specification | -| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | -| [VM Deployment](docs/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | -| [Features Gallery](docs/FEATURES.md) | Visual dashboard tour with screenshots | -| [Release Checklist](docs/RELEASE_CHECKLIST.md) | Pre-release validation steps | +| Document | Description | +| --------------------------------------------------------------------- | --------------------------------------------------- | +| [User Guide](docs/guides/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | +| [API Reference](docs/reference/API_REFERENCE.md) | All endpoints with examples | +| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | +| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | +| [Auto-Combo Engine](docs/routing/AUTO-COMBO.md) | 6-factor scoring, mode packs, self-healing | +| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | +| [Troubleshooting](docs/guides/TROUBLESHOOTING.md) | Common problems and solutions | +| [Architecture](docs/architecture/ARCHITECTURE.md) | System architecture and internals | +| [Codebase Documentation](docs/architecture/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | +| [Uninstall Guide](docs/guides/UNINSTALL.md) | Clean removal for all install methods | +| [Environment Config](docs/reference/ENVIRONMENT.md) | Complete `.env` variables and references | +| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | +| [OpenAPI Spec](docs/reference/openapi.yaml) | OpenAPI 3.0 specification | +| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | +| [VM Deployment](docs/ops/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | +| [Features Gallery](docs/guides/FEATURES.md) | Visual dashboard tour with screenshots | +| [Release Checklist](docs/ops/RELEASE_CHECKLIST.md) | Pre-release validation steps | --- diff --git a/docs/i18n/de/docs/ARCHITECTURE.md b/docs/i18n/de/docs/architecture/ARCHITECTURE.md similarity index 100% rename from docs/i18n/de/docs/ARCHITECTURE.md rename to docs/i18n/de/docs/architecture/ARCHITECTURE.md diff --git a/docs/i18n/de/docs/CODEBASE_DOCUMENTATION.md b/docs/i18n/de/docs/architecture/CODEBASE_DOCUMENTATION.md similarity index 100% rename from docs/i18n/de/docs/CODEBASE_DOCUMENTATION.md rename to docs/i18n/de/docs/architecture/CODEBASE_DOCUMENTATION.md diff --git a/docs/i18n/de/docs/A2A-SERVER.md b/docs/i18n/de/docs/frameworks/A2A-SERVER.md similarity index 100% rename from docs/i18n/de/docs/A2A-SERVER.md rename to docs/i18n/de/docs/frameworks/A2A-SERVER.md diff --git a/docs/i18n/de/docs/MCP-SERVER.md b/docs/i18n/de/docs/frameworks/MCP-SERVER.md similarity index 100% rename from docs/i18n/de/docs/MCP-SERVER.md rename to docs/i18n/de/docs/frameworks/MCP-SERVER.md diff --git a/docs/i18n/de/docs/FEATURES.md b/docs/i18n/de/docs/guides/FEATURES.md similarity index 100% rename from docs/i18n/de/docs/FEATURES.md rename to docs/i18n/de/docs/guides/FEATURES.md diff --git a/docs/i18n/de/docs/I18N.md b/docs/i18n/de/docs/guides/I18N.md similarity index 99% rename from docs/i18n/de/docs/I18N.md rename to docs/i18n/de/docs/guides/I18N.md index 84097d26c7..4236e2c2ee 100644 --- a/docs/i18n/de/docs/I18N.md +++ b/docs/i18n/de/docs/guides/I18N.md @@ -420,7 +420,7 @@ The generator originally used `code: "in"` (deprecated Google Translate code) fo ### `docs/i18n/README.md` Is Auto-Generated -The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/I18N.md` (this file) for hand-written documentation that should persist. +The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/guides/I18N.md` (this file) for hand-written documentation that should persist. ### External Untranslatable Keys List diff --git a/docs/i18n/de/docs/TROUBLESHOOTING.md b/docs/i18n/de/docs/guides/TROUBLESHOOTING.md similarity index 98% rename from docs/i18n/de/docs/TROUBLESHOOTING.md rename to docs/i18n/de/docs/guides/TROUBLESHOOTING.md index 7cf0a646e8..d7873c8243 100644 --- a/docs/i18n/de/docs/TROUBLESHOOTING.md +++ b/docs/i18n/de/docs/guides/TROUBLESHOOTING.md @@ -335,7 +335,7 @@ You can ignore this section if you do not run RAG or agent pipelines behind Omni ## Still Stuck? - **GitHub Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) -- **Architecture**: See [`docs/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details -- **API Reference**: See [`docs/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints - **Health Dashboard**: Check **Dashboard → Health** for real-time system status - **Translator**: Use **Dashboard → Translator** to debug format issues diff --git a/docs/i18n/de/docs/UNINSTALL.md b/docs/i18n/de/docs/guides/UNINSTALL.md similarity index 100% rename from docs/i18n/de/docs/UNINSTALL.md rename to docs/i18n/de/docs/guides/UNINSTALL.md diff --git a/docs/i18n/de/docs/USER_GUIDE.md b/docs/i18n/de/docs/guides/USER_GUIDE.md similarity index 100% rename from docs/i18n/de/docs/USER_GUIDE.md rename to docs/i18n/de/docs/guides/USER_GUIDE.md diff --git a/docs/i18n/de/docs/COVERAGE_PLAN.md b/docs/i18n/de/docs/ops/COVERAGE_PLAN.md similarity index 100% rename from docs/i18n/de/docs/COVERAGE_PLAN.md rename to docs/i18n/de/docs/ops/COVERAGE_PLAN.md diff --git a/docs/i18n/de/docs/FLY_IO_DEPLOYMENT_GUIDE.md b/docs/i18n/de/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/de/docs/FLY_IO_DEPLOYMENT_GUIDE.md rename to docs/i18n/de/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/de/docs/RELEASE_CHECKLIST.md b/docs/i18n/de/docs/ops/RELEASE_CHECKLIST.md similarity index 94% rename from docs/i18n/de/docs/RELEASE_CHECKLIST.md rename to docs/i18n/de/docs/ops/RELEASE_CHECKLIST.md index 3f69840951..f4eb8a8402 100644 --- a/docs/i18n/de/docs/RELEASE_CHECKLIST.md +++ b/docs/i18n/de/docs/ops/RELEASE_CHECKLIST.md @@ -16,14 +16,14 @@ Use this checklist before tagging or publishing a new OmniRoute release. ## API Docs -1. Update `docs/openapi.yaml`: +1. Update `docs/reference/openapi.yaml`: - `info.version` must equal `package.json` version. 2. Validate endpoint examples if API contracts changed. ## Runtime Docs -1. Review `docs/ARCHITECTURE.md` for storage/runtime drift. -2. Review `docs/TROUBLESHOOTING.md` for env var and operational drift. +1. Review `docs/architecture/ARCHITECTURE.md` for storage/runtime drift. +2. Review `docs/guides/TROUBLESHOOTING.md` for env var and operational drift. 3. Verify the release/runtime Node.js version still satisfies the supported secure floor: - `>=20.20.2 <21` or `>=22.22.2 <23` - `npm run check:node-runtime` diff --git a/docs/i18n/de/docs/VM_DEPLOYMENT_GUIDE.md b/docs/i18n/de/docs/ops/VM_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/de/docs/VM_DEPLOYMENT_GUIDE.md rename to docs/i18n/de/docs/ops/VM_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/de/docs/API_REFERENCE.md b/docs/i18n/de/docs/reference/API_REFERENCE.md similarity index 100% rename from docs/i18n/de/docs/API_REFERENCE.md rename to docs/i18n/de/docs/reference/API_REFERENCE.md diff --git a/docs/i18n/de/docs/CLI-TOOLS.md b/docs/i18n/de/docs/reference/CLI-TOOLS.md similarity index 100% rename from docs/i18n/de/docs/CLI-TOOLS.md rename to docs/i18n/de/docs/reference/CLI-TOOLS.md diff --git a/docs/i18n/de/docs/ENVIRONMENT.md b/docs/i18n/de/docs/reference/ENVIRONMENT.md similarity index 100% rename from docs/i18n/de/docs/ENVIRONMENT.md rename to docs/i18n/de/docs/reference/ENVIRONMENT.md diff --git a/docs/i18n/de/docs/AUTO-COMBO.md b/docs/i18n/de/docs/routing/AUTO-COMBO.md similarity index 100% rename from docs/i18n/de/docs/AUTO-COMBO.md rename to docs/i18n/de/docs/routing/AUTO-COMBO.md diff --git a/docs/i18n/de/llm.txt b/docs/i18n/de/llm.txt index 55c98f2226..db7fd0b695 100644 --- a/docs/i18n/de/llm.txt +++ b/docs/i18n/de/llm.txt @@ -357,11 +357,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### MCP Server (37 Tools) | Category | Tools | |------------|-------| -| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/MCP-SERVER.md` for full inventory) | +| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/frameworks/MCP-SERVER.md` for full inventory) | | Memory (3) | `memory_search`, `memory_add`, `memory_clear` | | Skills (4) | `skills_list`, `skills_enable`, `skills_execute`, `skills_executions` | -**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/MCP-SERVER.md`. +**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/frameworks/MCP-SERVER.md`. ### Provider Categories @@ -472,7 +472,7 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo 20. **Guardrails framework** in `src/lib/guardrails/` — hot-reloadable registry. Built-ins (priority-ordered): `vision-bridge` (5) → `pii-masker` (10) → `prompt-injection` (20). Fail-open model: exceptions never block traffic. Per-request opt-out via `x-omniroute-disabled-guardrails` header. -21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/AUTHZ_GUIDE.md`. +21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/architecture/AUTHZ_GUIDE.md`. 22. **Three resilience layers** are distinct (do not conflate them): - **Provider Circuit Breaker** (`src/shared/utils/circuitBreaker.ts`) — whole-provider scope. @@ -489,11 +489,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo - **MCP server expanded to 37 tools** (30 base + 3 memory + 4 skills) across ~13 scopes - **OAuth providers expanded to 14**: added Qwen, Kiro, Qoder, Gemini, Windsurf, GitLab Duo - **Coverage gate raised to 75/75/75/70** (was 60% across the board) — measured ~82% -- **Reasoning replay** (`docs/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams +- **Reasoning replay** (`docs/routing/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams - **Compliance + Evals + Webhooks** documentation introduced -- **Stealth guide** (`docs/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration -- **Tunnels guide** (`docs/TUNNELS_GUIDE.md`) — Cloudflare tunnel management -- **Electron guide** (`docs/ELECTRON_GUIDE.md`) — desktop app build + signing +- **Stealth guide** (`docs/security/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration +- **Tunnels guide** (`docs/ops/TUNNELS_GUIDE.md`) — Cloudflare tunnel management +- **Electron guide** (`docs/guides/ELECTRON_GUIDE.md`) — desktop app build + signing ## Links @@ -505,11 +505,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### Documentation Index -- **Architecture & Reference**: `docs/ARCHITECTURE.md`, `docs/CODEBASE_DOCUMENTATION.md`, `docs/REPOSITORY_MAP.md`, `docs/API_REFERENCE.md`, `docs/PROVIDER_REFERENCE.md`, `docs/openapi.yaml` -- **Operator guides**: `docs/USER_GUIDE.md`, `docs/CLI-TOOLS.md`, `docs/TROUBLESHOOTING.md`, `docs/COVERAGE_PLAN.md` -- **Protocols**: `docs/MCP-SERVER.md`, `docs/A2A-SERVER.md`, `docs/AGENT_PROTOCOLS_GUIDE.md`, `docs/CLOUD_AGENT.md` -- **Routing & resilience**: `docs/AUTO-COMBO.md`, `docs/RESILIENCE_GUIDE.md` -- **Security**: `docs/AUTHZ_GUIDE.md`, `docs/GUARDRAILS.md`, `docs/COMPLIANCE.md`, `docs/STEALTH_GUIDE.md` -- **Extensibility**: `docs/SKILLS.md`, `docs/MEMORY.md`, `docs/EVALS.md`, `docs/WEBHOOKS.md`, `docs/REASONING_REPLAY.md` -- **Platform**: `docs/ELECTRON_GUIDE.md`, `docs/TUNNELS_GUIDE.md` +- **Architecture & Reference**: `docs/architecture/ARCHITECTURE.md`, `docs/architecture/CODEBASE_DOCUMENTATION.md`, `docs/architecture/REPOSITORY_MAP.md`, `docs/reference/API_REFERENCE.md`, `docs/reference/PROVIDER_REFERENCE.md`, `docs/reference/openapi.yaml` +- **Operator guides**: `docs/guides/USER_GUIDE.md`, `docs/reference/CLI-TOOLS.md`, `docs/guides/TROUBLESHOOTING.md`, `docs/ops/COVERAGE_PLAN.md` +- **Protocols**: `docs/frameworks/MCP-SERVER.md`, `docs/frameworks/A2A-SERVER.md`, `docs/frameworks/AGENT_PROTOCOLS_GUIDE.md`, `docs/frameworks/CLOUD_AGENT.md` +- **Routing & resilience**: `docs/routing/AUTO-COMBO.md`, `docs/architecture/RESILIENCE_GUIDE.md` +- **Security**: `docs/architecture/AUTHZ_GUIDE.md`, `docs/security/GUARDRAILS.md`, `docs/security/COMPLIANCE.md`, `docs/security/STEALTH_GUIDE.md` +- **Extensibility**: `docs/frameworks/SKILLS.md`, `docs/frameworks/MEMORY.md`, `docs/frameworks/EVALS.md`, `docs/frameworks/WEBHOOKS.md`, `docs/routing/REASONING_REPLAY.md` +- **Platform**: `docs/guides/ELECTRON_GUIDE.md`, `docs/ops/TUNNELS_GUIDE.md` - **AI agents**: `CLAUDE.md`, `AGENTS.md`, `GEMINI.md` diff --git a/docs/i18n/es/CHANGELOG.md b/docs/i18n/es/CHANGELOG.md index 913b323c61..1c039bb37e 100644 --- a/docs/i18n/es/CHANGELOG.md +++ b/docs/i18n/es/CHANGELOG.md @@ -1310,7 +1310,7 @@ We identified that **155 community PRs** across the entire project history (from - **33 New API Key Providers:** Massive provider expansion adding DeepInfra, Vercel AI Gateway, Lambda AI, SambaNova, nScale, OVHcloud AI, Baseten, PublicAI, Moonshot AI, Meta Llama API, v0 (Vercel), Morph, Featherless AI, FriendliAI, LlamaGate, Galadriel, Weights & Biases Inference, Volcengine, AI21 Labs, Venice.ai, Codestral, Upstage, Maritalk, Xiaomi MiMo, Inference.net, NanoGPT, Predibase, Bytez, Heroku AI, Databricks, Snowflake Cortex, and GigaChat (Sber). OmniRoute now supports **100+ providers** (4 Free + 8 OAuth + 91 API Key + Custom compatible) - **Global Email Privacy Toggle:** Added a persistent eye-icon toggle button across all dashboard pages (Providers, Usage Limits, Playground) that reveals or hides masked email addresses. Toggle state is stored in localStorage and synced globally via Zustand store - **Documentation Refresh:** Updated README, ARCHITECTURE, FEATURES, AGENTS.md, and API_REFERENCE for v3.6.2 with accurate provider counts (100+), new executor list, and system API documentation -- **Uninstall Guide:** Created comprehensive `docs/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) +- **Uninstall Guide:** Created comprehensive `docs/guides/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) ### 🐛 Bug Fixes diff --git a/docs/i18n/es/CONTRIBUTING.md b/docs/i18n/es/CONTRIBUTING.md index e5f054b239..b8ac893ed2 100644 --- a/docs/i18n/es/CONTRIBUTING.md +++ b/docs/i18n/es/CONTRIBUTING.md @@ -153,7 +153,7 @@ Coverage notes: - If a PR changes production code in `src/`, `open-sse/`, `electron/`, or `bin/`, it must add or update automated tests in the same PR - `npm run coverage:report` prints the detailed file-by-file report from the latest coverage run - `npm run test:coverage:legacy` preserves the older metric for historical comparison -- See `docs/COVERAGE_PLAN.md` for the phased coverage improvement roadmap +- See `docs/ops/COVERAGE_PLAN.md` for the phased coverage improvement roadmap ### Pull Request Requirements @@ -305,7 +305,7 @@ Releases are managed via the `/generate-release` workflow. When a new GitHub Rel ## Getting Help -- **Architecture**: See [`docs/ARCHITECTURE.md`](docs/ARCHITECTURE.md) -- **API Reference**: See [`docs/API_REFERENCE.md`](docs/API_REFERENCE.md) +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](docs/architecture/ARCHITECTURE.md) +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](docs/reference/API_REFERENCE.md) - **Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) - **ADRs**: See `docs/adr/` for architectural decision records diff --git a/docs/i18n/es/README.md b/docs/i18n/es/README.md index 6ecc419bbd..00609d63d5 100644 --- a/docs/i18n/es/README.md +++ b/docs/i18n/es/README.md @@ -2267,25 +2267,25 @@ Se não quiser criar credenciais próprias agora, ainda é possível usar o flux ## Documentación -| Document | Description | -| -------------------------------------------------------- | --------------------------------------------------- | -| [User Guide](docs/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | -| [API Reference](docs/API_REFERENCE.md) | All endpoints with examples | -| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | -| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | -| [Auto-Combo Engine](docs/AUTO-COMBO.md) | 6-factor scoring, mode packs, self-healing | -| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | -| [Troubleshooting](docs/TROUBLESHOOTING.md) | Common problems and solutions | -| [Architecture](docs/ARCHITECTURE.md) | System architecture and internals | -| [Codebase Documentation](docs/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | -| [Uninstall Guide](docs/UNINSTALL.md) | Clean removal for all install methods | -| [Environment Config](docs/ENVIRONMENT.md) | Complete `.env` variables and references | -| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | -| [OpenAPI Spec](docs/openapi.yaml) | OpenAPI 3.0 specification | -| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | -| [VM Deployment](docs/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | -| [Features Gallery](docs/FEATURES.md) | Visual dashboard tour with screenshots | -| [Release Checklist](docs/RELEASE_CHECKLIST.md) | Pre-release validation steps | +| Document | Description | +| --------------------------------------------------------------------- | --------------------------------------------------- | +| [User Guide](docs/guides/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | +| [API Reference](docs/reference/API_REFERENCE.md) | All endpoints with examples | +| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | +| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | +| [Auto-Combo Engine](docs/routing/AUTO-COMBO.md) | 6-factor scoring, mode packs, self-healing | +| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | +| [Troubleshooting](docs/guides/TROUBLESHOOTING.md) | Common problems and solutions | +| [Architecture](docs/architecture/ARCHITECTURE.md) | System architecture and internals | +| [Codebase Documentation](docs/architecture/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | +| [Uninstall Guide](docs/guides/UNINSTALL.md) | Clean removal for all install methods | +| [Environment Config](docs/reference/ENVIRONMENT.md) | Complete `.env` variables and references | +| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | +| [OpenAPI Spec](docs/reference/openapi.yaml) | OpenAPI 3.0 specification | +| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | +| [VM Deployment](docs/ops/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | +| [Features Gallery](docs/guides/FEATURES.md) | Visual dashboard tour with screenshots | +| [Release Checklist](docs/ops/RELEASE_CHECKLIST.md) | Pre-release validation steps | --- diff --git a/docs/i18n/es/docs/ARCHITECTURE.md b/docs/i18n/es/docs/architecture/ARCHITECTURE.md similarity index 100% rename from docs/i18n/es/docs/ARCHITECTURE.md rename to docs/i18n/es/docs/architecture/ARCHITECTURE.md diff --git a/docs/i18n/es/docs/CODEBASE_DOCUMENTATION.md b/docs/i18n/es/docs/architecture/CODEBASE_DOCUMENTATION.md similarity index 100% rename from docs/i18n/es/docs/CODEBASE_DOCUMENTATION.md rename to docs/i18n/es/docs/architecture/CODEBASE_DOCUMENTATION.md diff --git a/docs/i18n/es/docs/A2A-SERVER.md b/docs/i18n/es/docs/frameworks/A2A-SERVER.md similarity index 100% rename from docs/i18n/es/docs/A2A-SERVER.md rename to docs/i18n/es/docs/frameworks/A2A-SERVER.md diff --git a/docs/i18n/es/docs/MCP-SERVER.md b/docs/i18n/es/docs/frameworks/MCP-SERVER.md similarity index 100% rename from docs/i18n/es/docs/MCP-SERVER.md rename to docs/i18n/es/docs/frameworks/MCP-SERVER.md diff --git a/docs/i18n/es/docs/FEATURES.md b/docs/i18n/es/docs/guides/FEATURES.md similarity index 100% rename from docs/i18n/es/docs/FEATURES.md rename to docs/i18n/es/docs/guides/FEATURES.md diff --git a/docs/i18n/es/docs/I18N.md b/docs/i18n/es/docs/guides/I18N.md similarity index 99% rename from docs/i18n/es/docs/I18N.md rename to docs/i18n/es/docs/guides/I18N.md index 628065c212..c9f3a93945 100644 --- a/docs/i18n/es/docs/I18N.md +++ b/docs/i18n/es/docs/guides/I18N.md @@ -420,7 +420,7 @@ The generator originally used `code: "in"` (deprecated Google Translate code) fo ### `docs/i18n/README.md` Is Auto-Generated -The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/I18N.md` (this file) for hand-written documentation that should persist. +The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/guides/I18N.md` (this file) for hand-written documentation that should persist. ### External Untranslatable Keys List diff --git a/docs/i18n/es/docs/TROUBLESHOOTING.md b/docs/i18n/es/docs/guides/TROUBLESHOOTING.md similarity index 98% rename from docs/i18n/es/docs/TROUBLESHOOTING.md rename to docs/i18n/es/docs/guides/TROUBLESHOOTING.md index fc65ae406a..bd261b22d2 100644 --- a/docs/i18n/es/docs/TROUBLESHOOTING.md +++ b/docs/i18n/es/docs/guides/TROUBLESHOOTING.md @@ -335,7 +335,7 @@ You can ignore this section if you do not run RAG or agent pipelines behind Omni ## Still Stuck? - **GitHub Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) -- **Architecture**: See [`docs/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details -- **API Reference**: See [`docs/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints - **Health Dashboard**: Check **Dashboard → Health** for real-time system status - **Translator**: Use **Dashboard → Translator** to debug format issues diff --git a/docs/i18n/es/docs/UNINSTALL.md b/docs/i18n/es/docs/guides/UNINSTALL.md similarity index 100% rename from docs/i18n/es/docs/UNINSTALL.md rename to docs/i18n/es/docs/guides/UNINSTALL.md diff --git a/docs/i18n/es/docs/USER_GUIDE.md b/docs/i18n/es/docs/guides/USER_GUIDE.md similarity index 100% rename from docs/i18n/es/docs/USER_GUIDE.md rename to docs/i18n/es/docs/guides/USER_GUIDE.md diff --git a/docs/i18n/es/docs/COVERAGE_PLAN.md b/docs/i18n/es/docs/ops/COVERAGE_PLAN.md similarity index 100% rename from docs/i18n/es/docs/COVERAGE_PLAN.md rename to docs/i18n/es/docs/ops/COVERAGE_PLAN.md diff --git a/docs/i18n/es/docs/FLY_IO_DEPLOYMENT_GUIDE.md b/docs/i18n/es/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/es/docs/FLY_IO_DEPLOYMENT_GUIDE.md rename to docs/i18n/es/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/es/docs/RELEASE_CHECKLIST.md b/docs/i18n/es/docs/ops/RELEASE_CHECKLIST.md similarity index 94% rename from docs/i18n/es/docs/RELEASE_CHECKLIST.md rename to docs/i18n/es/docs/ops/RELEASE_CHECKLIST.md index 2d4c11840e..7f0e5ff56d 100644 --- a/docs/i18n/es/docs/RELEASE_CHECKLIST.md +++ b/docs/i18n/es/docs/ops/RELEASE_CHECKLIST.md @@ -16,14 +16,14 @@ Use this checklist before tagging or publishing a new OmniRoute release. ## API Docs -1. Update `docs/openapi.yaml`: +1. Update `docs/reference/openapi.yaml`: - `info.version` must equal `package.json` version. 2. Validate endpoint examples if API contracts changed. ## Runtime Docs -1. Review `docs/ARCHITECTURE.md` for storage/runtime drift. -2. Review `docs/TROUBLESHOOTING.md` for env var and operational drift. +1. Review `docs/architecture/ARCHITECTURE.md` for storage/runtime drift. +2. Review `docs/guides/TROUBLESHOOTING.md` for env var and operational drift. 3. Verify the release/runtime Node.js version still satisfies the supported secure floor: - `>=20.20.2 <21` or `>=22.22.2 <23` - `npm run check:node-runtime` diff --git a/docs/i18n/es/docs/VM_DEPLOYMENT_GUIDE.md b/docs/i18n/es/docs/ops/VM_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/es/docs/VM_DEPLOYMENT_GUIDE.md rename to docs/i18n/es/docs/ops/VM_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/es/docs/API_REFERENCE.md b/docs/i18n/es/docs/reference/API_REFERENCE.md similarity index 100% rename from docs/i18n/es/docs/API_REFERENCE.md rename to docs/i18n/es/docs/reference/API_REFERENCE.md diff --git a/docs/i18n/es/docs/CLI-TOOLS.md b/docs/i18n/es/docs/reference/CLI-TOOLS.md similarity index 100% rename from docs/i18n/es/docs/CLI-TOOLS.md rename to docs/i18n/es/docs/reference/CLI-TOOLS.md diff --git a/docs/i18n/es/docs/ENVIRONMENT.md b/docs/i18n/es/docs/reference/ENVIRONMENT.md similarity index 100% rename from docs/i18n/es/docs/ENVIRONMENT.md rename to docs/i18n/es/docs/reference/ENVIRONMENT.md diff --git a/docs/i18n/es/docs/AUTO-COMBO.md b/docs/i18n/es/docs/routing/AUTO-COMBO.md similarity index 100% rename from docs/i18n/es/docs/AUTO-COMBO.md rename to docs/i18n/es/docs/routing/AUTO-COMBO.md diff --git a/docs/i18n/es/llm.txt b/docs/i18n/es/llm.txt index 2dbf99212d..d822c3352e 100644 --- a/docs/i18n/es/llm.txt +++ b/docs/i18n/es/llm.txt @@ -357,11 +357,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### MCP Server (37 Tools) | Category | Tools | |------------|-------| -| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/MCP-SERVER.md` for full inventory) | +| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/frameworks/MCP-SERVER.md` for full inventory) | | Memory (3) | `memory_search`, `memory_add`, `memory_clear` | | Skills (4) | `skills_list`, `skills_enable`, `skills_execute`, `skills_executions` | -**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/MCP-SERVER.md`. +**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/frameworks/MCP-SERVER.md`. ### Provider Categories @@ -472,7 +472,7 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo 20. **Guardrails framework** in `src/lib/guardrails/` — hot-reloadable registry. Built-ins (priority-ordered): `vision-bridge` (5) → `pii-masker` (10) → `prompt-injection` (20). Fail-open model: exceptions never block traffic. Per-request opt-out via `x-omniroute-disabled-guardrails` header. -21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/AUTHZ_GUIDE.md`. +21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/architecture/AUTHZ_GUIDE.md`. 22. **Three resilience layers** are distinct (do not conflate them): - **Provider Circuit Breaker** (`src/shared/utils/circuitBreaker.ts`) — whole-provider scope. @@ -489,11 +489,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo - **MCP server expanded to 37 tools** (30 base + 3 memory + 4 skills) across ~13 scopes - **OAuth providers expanded to 14**: added Qwen, Kiro, Qoder, Gemini, Windsurf, GitLab Duo - **Coverage gate raised to 75/75/75/70** (was 60% across the board) — measured ~82% -- **Reasoning replay** (`docs/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams +- **Reasoning replay** (`docs/routing/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams - **Compliance + Evals + Webhooks** documentation introduced -- **Stealth guide** (`docs/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration -- **Tunnels guide** (`docs/TUNNELS_GUIDE.md`) — Cloudflare tunnel management -- **Electron guide** (`docs/ELECTRON_GUIDE.md`) — desktop app build + signing +- **Stealth guide** (`docs/security/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration +- **Tunnels guide** (`docs/ops/TUNNELS_GUIDE.md`) — Cloudflare tunnel management +- **Electron guide** (`docs/guides/ELECTRON_GUIDE.md`) — desktop app build + signing ## Links @@ -505,11 +505,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### Documentation Index -- **Architecture & Reference**: `docs/ARCHITECTURE.md`, `docs/CODEBASE_DOCUMENTATION.md`, `docs/REPOSITORY_MAP.md`, `docs/API_REFERENCE.md`, `docs/PROVIDER_REFERENCE.md`, `docs/openapi.yaml` -- **Operator guides**: `docs/USER_GUIDE.md`, `docs/CLI-TOOLS.md`, `docs/TROUBLESHOOTING.md`, `docs/COVERAGE_PLAN.md` -- **Protocols**: `docs/MCP-SERVER.md`, `docs/A2A-SERVER.md`, `docs/AGENT_PROTOCOLS_GUIDE.md`, `docs/CLOUD_AGENT.md` -- **Routing & resilience**: `docs/AUTO-COMBO.md`, `docs/RESILIENCE_GUIDE.md` -- **Security**: `docs/AUTHZ_GUIDE.md`, `docs/GUARDRAILS.md`, `docs/COMPLIANCE.md`, `docs/STEALTH_GUIDE.md` -- **Extensibility**: `docs/SKILLS.md`, `docs/MEMORY.md`, `docs/EVALS.md`, `docs/WEBHOOKS.md`, `docs/REASONING_REPLAY.md` -- **Platform**: `docs/ELECTRON_GUIDE.md`, `docs/TUNNELS_GUIDE.md` +- **Architecture & Reference**: `docs/architecture/ARCHITECTURE.md`, `docs/architecture/CODEBASE_DOCUMENTATION.md`, `docs/architecture/REPOSITORY_MAP.md`, `docs/reference/API_REFERENCE.md`, `docs/reference/PROVIDER_REFERENCE.md`, `docs/reference/openapi.yaml` +- **Operator guides**: `docs/guides/USER_GUIDE.md`, `docs/reference/CLI-TOOLS.md`, `docs/guides/TROUBLESHOOTING.md`, `docs/ops/COVERAGE_PLAN.md` +- **Protocols**: `docs/frameworks/MCP-SERVER.md`, `docs/frameworks/A2A-SERVER.md`, `docs/frameworks/AGENT_PROTOCOLS_GUIDE.md`, `docs/frameworks/CLOUD_AGENT.md` +- **Routing & resilience**: `docs/routing/AUTO-COMBO.md`, `docs/architecture/RESILIENCE_GUIDE.md` +- **Security**: `docs/architecture/AUTHZ_GUIDE.md`, `docs/security/GUARDRAILS.md`, `docs/security/COMPLIANCE.md`, `docs/security/STEALTH_GUIDE.md` +- **Extensibility**: `docs/frameworks/SKILLS.md`, `docs/frameworks/MEMORY.md`, `docs/frameworks/EVALS.md`, `docs/frameworks/WEBHOOKS.md`, `docs/routing/REASONING_REPLAY.md` +- **Platform**: `docs/guides/ELECTRON_GUIDE.md`, `docs/ops/TUNNELS_GUIDE.md` - **AI agents**: `CLAUDE.md`, `AGENTS.md`, `GEMINI.md` diff --git a/docs/i18n/fa/CHANGELOG.md b/docs/i18n/fa/CHANGELOG.md index bcfe7dd067..c620c1adda 100644 --- a/docs/i18n/fa/CHANGELOG.md +++ b/docs/i18n/fa/CHANGELOG.md @@ -1310,7 +1310,7 @@ We identified that **155 community PRs** across the entire project history (from - **33 New API Key Providers:** Massive provider expansion adding DeepInfra, Vercel AI Gateway, Lambda AI, SambaNova, nScale, OVHcloud AI, Baseten, PublicAI, Moonshot AI, Meta Llama API, v0 (Vercel), Morph, Featherless AI, FriendliAI, LlamaGate, Galadriel, Weights & Biases Inference, Volcengine, AI21 Labs, Venice.ai, Codestral, Upstage, Maritalk, Xiaomi MiMo, Inference.net, NanoGPT, Predibase, Bytez, Heroku AI, Databricks, Snowflake Cortex, and GigaChat (Sber). OmniRoute now supports **100+ providers** (4 Free + 8 OAuth + 91 API Key + Custom compatible) - **Global Email Privacy Toggle:** Added a persistent eye-icon toggle button across all dashboard pages (Providers, Usage Limits, Playground) that reveals or hides masked email addresses. Toggle state is stored in localStorage and synced globally via Zustand store - **Documentation Refresh:** Updated README, ARCHITECTURE, FEATURES, AGENTS.md, and API_REFERENCE for v3.6.2 with accurate provider counts (100+), new executor list, and system API documentation -- **Uninstall Guide:** Created comprehensive `docs/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) +- **Uninstall Guide:** Created comprehensive `docs/guides/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) ### 🐛 Bug Fixes diff --git a/docs/i18n/fa/CONTRIBUTING.md b/docs/i18n/fa/CONTRIBUTING.md index 30a6e8caba..d57949243e 100644 --- a/docs/i18n/fa/CONTRIBUTING.md +++ b/docs/i18n/fa/CONTRIBUTING.md @@ -153,7 +153,7 @@ Coverage notes: - If a PR changes production code in `src/`, `open-sse/`, `electron/`, or `bin/`, it must add or update automated tests in the same PR - `npm run coverage:report` prints the detailed file-by-file report from the latest coverage run - `npm run test:coverage:legacy` preserves the older metric for historical comparison -- See `docs/COVERAGE_PLAN.md` for the phased coverage improvement roadmap +- See `docs/ops/COVERAGE_PLAN.md` for the phased coverage improvement roadmap ### Pull Request Requirements @@ -305,7 +305,7 @@ Releases are managed via the `/generate-release` workflow. When a new GitHub Rel ## Getting Help -- **Architecture**: See [`docs/ARCHITECTURE.md`](docs/ARCHITECTURE.md) -- **API Reference**: See [`docs/API_REFERENCE.md`](docs/API_REFERENCE.md) +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](docs/architecture/ARCHITECTURE.md) +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](docs/reference/API_REFERENCE.md) - **Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) - **ADRs**: See `docs/adr/` for architectural decision records diff --git a/docs/i18n/fa/README.md b/docs/i18n/fa/README.md index 57b1f66938..74436b40be 100644 --- a/docs/i18n/fa/README.md +++ b/docs/i18n/fa/README.md @@ -2267,25 +2267,25 @@ Se não quiser criar credenciais próprias agora, ainda é possível usar o flux ## Documentación -| Document | Description | -| -------------------------------------------------------- | --------------------------------------------------- | -| [User Guide](docs/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | -| [API Reference](docs/API_REFERENCE.md) | All endpoints with examples | -| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | -| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | -| [Auto-Combo Engine](docs/auto-combo.md) | 6-factor scoring, mode packs, self-healing | -| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | -| [Troubleshooting](docs/TROUBLESHOOTING.md) | Common problems and solutions | -| [Architecture](docs/ARCHITECTURE.md) | System architecture and internals | -| [Codebase Documentation](docs/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | -| [Uninstall Guide](docs/UNINSTALL.md) | Clean removal for all install methods | -| [Environment Config](docs/ENVIRONMENT.md) | Complete `.env` variables and references | -| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | -| [OpenAPI Spec](docs/openapi.yaml) | OpenAPI 3.0 specification | -| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | -| [VM Deployment](docs/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | -| [Features Gallery](docs/FEATURES.md) | Visual dashboard tour with screenshots | -| [Release Checklist](docs/RELEASE_CHECKLIST.md) | Pre-release validation steps | +| Document | Description | +| --------------------------------------------------------------------- | --------------------------------------------------- | +| [User Guide](docs/guides/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | +| [API Reference](docs/reference/API_REFERENCE.md) | All endpoints with examples | +| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | +| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | +| [Auto-Combo Engine](docs/auto-combo.md) | 6-factor scoring, mode packs, self-healing | +| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | +| [Troubleshooting](docs/guides/TROUBLESHOOTING.md) | Common problems and solutions | +| [Architecture](docs/architecture/ARCHITECTURE.md) | System architecture and internals | +| [Codebase Documentation](docs/architecture/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | +| [Uninstall Guide](docs/guides/UNINSTALL.md) | Clean removal for all install methods | +| [Environment Config](docs/reference/ENVIRONMENT.md) | Complete `.env` variables and references | +| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | +| [OpenAPI Spec](docs/reference/openapi.yaml) | OpenAPI 3.0 specification | +| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | +| [VM Deployment](docs/ops/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | +| [Features Gallery](docs/guides/FEATURES.md) | Visual dashboard tour with screenshots | +| [Release Checklist](docs/ops/RELEASE_CHECKLIST.md) | Pre-release validation steps | --- diff --git a/docs/i18n/fa/docs/ARCHITECTURE.md b/docs/i18n/fa/docs/architecture/ARCHITECTURE.md similarity index 100% rename from docs/i18n/fa/docs/ARCHITECTURE.md rename to docs/i18n/fa/docs/architecture/ARCHITECTURE.md diff --git a/docs/i18n/fa/docs/CODEBASE_DOCUMENTATION.md b/docs/i18n/fa/docs/architecture/CODEBASE_DOCUMENTATION.md similarity index 100% rename from docs/i18n/fa/docs/CODEBASE_DOCUMENTATION.md rename to docs/i18n/fa/docs/architecture/CODEBASE_DOCUMENTATION.md diff --git a/docs/i18n/fa/docs/A2A-SERVER.md b/docs/i18n/fa/docs/frameworks/A2A-SERVER.md similarity index 100% rename from docs/i18n/fa/docs/A2A-SERVER.md rename to docs/i18n/fa/docs/frameworks/A2A-SERVER.md diff --git a/docs/i18n/fa/docs/MCP-SERVER.md b/docs/i18n/fa/docs/frameworks/MCP-SERVER.md similarity index 100% rename from docs/i18n/fa/docs/MCP-SERVER.md rename to docs/i18n/fa/docs/frameworks/MCP-SERVER.md diff --git a/docs/i18n/fa/docs/FEATURES.md b/docs/i18n/fa/docs/guides/FEATURES.md similarity index 100% rename from docs/i18n/fa/docs/FEATURES.md rename to docs/i18n/fa/docs/guides/FEATURES.md diff --git a/docs/i18n/fa/docs/I18N.md b/docs/i18n/fa/docs/guides/I18N.md similarity index 99% rename from docs/i18n/fa/docs/I18N.md rename to docs/i18n/fa/docs/guides/I18N.md index fd8a3bce37..00d108904a 100644 --- a/docs/i18n/fa/docs/I18N.md +++ b/docs/i18n/fa/docs/guides/I18N.md @@ -420,7 +420,7 @@ The generator originally used `code: "in"` (deprecated Google Translate code) fo ### `docs/i18n/README.md` Is Auto-Generated -The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/I18N.md` (this file) for hand-written documentation that should persist. +The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/guides/I18N.md` (this file) for hand-written documentation that should persist. ### External Untranslatable Keys List diff --git a/docs/i18n/fa/docs/TROUBLESHOOTING.md b/docs/i18n/fa/docs/guides/TROUBLESHOOTING.md similarity index 98% rename from docs/i18n/fa/docs/TROUBLESHOOTING.md rename to docs/i18n/fa/docs/guides/TROUBLESHOOTING.md index e573b1b007..2c0ee1b9c1 100644 --- a/docs/i18n/fa/docs/TROUBLESHOOTING.md +++ b/docs/i18n/fa/docs/guides/TROUBLESHOOTING.md @@ -335,7 +335,7 @@ You can ignore this section if you do not run RAG or agent pipelines behind Omni ## Still Stuck? - **GitHub Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) -- **Architecture**: See [`docs/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details -- **API Reference**: See [`docs/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints - **Health Dashboard**: Check **Dashboard → Health** for real-time system status - **Translator**: Use **Dashboard → Translator** to debug format issues diff --git a/docs/i18n/fa/docs/UNINSTALL.md b/docs/i18n/fa/docs/guides/UNINSTALL.md similarity index 100% rename from docs/i18n/fa/docs/UNINSTALL.md rename to docs/i18n/fa/docs/guides/UNINSTALL.md diff --git a/docs/i18n/fa/docs/USER_GUIDE.md b/docs/i18n/fa/docs/guides/USER_GUIDE.md similarity index 100% rename from docs/i18n/fa/docs/USER_GUIDE.md rename to docs/i18n/fa/docs/guides/USER_GUIDE.md diff --git a/docs/i18n/fa/docs/COVERAGE_PLAN.md b/docs/i18n/fa/docs/ops/COVERAGE_PLAN.md similarity index 100% rename from docs/i18n/fa/docs/COVERAGE_PLAN.md rename to docs/i18n/fa/docs/ops/COVERAGE_PLAN.md diff --git a/docs/i18n/fa/docs/FLY_IO_DEPLOYMENT_GUIDE.md b/docs/i18n/fa/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/fa/docs/FLY_IO_DEPLOYMENT_GUIDE.md rename to docs/i18n/fa/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/fa/docs/RELEASE_CHECKLIST.md b/docs/i18n/fa/docs/ops/RELEASE_CHECKLIST.md similarity index 94% rename from docs/i18n/fa/docs/RELEASE_CHECKLIST.md rename to docs/i18n/fa/docs/ops/RELEASE_CHECKLIST.md index 545a1c7eb9..8193817209 100644 --- a/docs/i18n/fa/docs/RELEASE_CHECKLIST.md +++ b/docs/i18n/fa/docs/ops/RELEASE_CHECKLIST.md @@ -16,14 +16,14 @@ Use this checklist before tagging or publishing a new OmniRoute release. ## API Docs -1. Update `docs/openapi.yaml`: +1. Update `docs/reference/openapi.yaml`: - `info.version` must equal `package.json` version. 2. Validate endpoint examples if API contracts changed. ## Runtime Docs -1. Review `docs/ARCHITECTURE.md` for storage/runtime drift. -2. Review `docs/TROUBLESHOOTING.md` for env var and operational drift. +1. Review `docs/architecture/ARCHITECTURE.md` for storage/runtime drift. +2. Review `docs/guides/TROUBLESHOOTING.md` for env var and operational drift. 3. Verify the release/runtime Node.js version still satisfies the supported secure floor: - `>=20.20.2 <21` or `>=22.22.2 <23` - `npm run check:node-runtime` diff --git a/docs/i18n/fa/docs/VM_DEPLOYMENT_GUIDE.md b/docs/i18n/fa/docs/ops/VM_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/fa/docs/VM_DEPLOYMENT_GUIDE.md rename to docs/i18n/fa/docs/ops/VM_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/fa/docs/API_REFERENCE.md b/docs/i18n/fa/docs/reference/API_REFERENCE.md similarity index 100% rename from docs/i18n/fa/docs/API_REFERENCE.md rename to docs/i18n/fa/docs/reference/API_REFERENCE.md diff --git a/docs/i18n/fa/docs/CLI-TOOLS.md b/docs/i18n/fa/docs/reference/CLI-TOOLS.md similarity index 100% rename from docs/i18n/fa/docs/CLI-TOOLS.md rename to docs/i18n/fa/docs/reference/CLI-TOOLS.md diff --git a/docs/i18n/fa/docs/ENVIRONMENT.md b/docs/i18n/fa/docs/reference/ENVIRONMENT.md similarity index 100% rename from docs/i18n/fa/docs/ENVIRONMENT.md rename to docs/i18n/fa/docs/reference/ENVIRONMENT.md diff --git a/docs/i18n/fa/docs/AUTO-COMBO.md b/docs/i18n/fa/docs/routing/AUTO-COMBO.md similarity index 100% rename from docs/i18n/fa/docs/AUTO-COMBO.md rename to docs/i18n/fa/docs/routing/AUTO-COMBO.md diff --git a/docs/i18n/fa/llm.txt b/docs/i18n/fa/llm.txt index 43d14c5164..a0da959704 100644 --- a/docs/i18n/fa/llm.txt +++ b/docs/i18n/fa/llm.txt @@ -357,11 +357,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### MCP Server (37 Tools) | Category | Tools | |------------|-------| -| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/MCP-SERVER.md` for full inventory) | +| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/frameworks/MCP-SERVER.md` for full inventory) | | Memory (3) | `memory_search`, `memory_add`, `memory_clear` | | Skills (4) | `skills_list`, `skills_enable`, `skills_execute`, `skills_executions` | -**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/MCP-SERVER.md`. +**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/frameworks/MCP-SERVER.md`. ### Provider Categories @@ -472,7 +472,7 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo 20. **Guardrails framework** in `src/lib/guardrails/` — hot-reloadable registry. Built-ins (priority-ordered): `vision-bridge` (5) → `pii-masker` (10) → `prompt-injection` (20). Fail-open model: exceptions never block traffic. Per-request opt-out via `x-omniroute-disabled-guardrails` header. -21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/AUTHZ_GUIDE.md`. +21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/architecture/AUTHZ_GUIDE.md`. 22. **Three resilience layers** are distinct (do not conflate them): - **Provider Circuit Breaker** (`src/shared/utils/circuitBreaker.ts`) — whole-provider scope. @@ -489,11 +489,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo - **MCP server expanded to 37 tools** (30 base + 3 memory + 4 skills) across ~13 scopes - **OAuth providers expanded to 14**: added Qwen, Kiro, Qoder, Gemini, Windsurf, GitLab Duo - **Coverage gate raised to 75/75/75/70** (was 60% across the board) — measured ~82% -- **Reasoning replay** (`docs/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams +- **Reasoning replay** (`docs/routing/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams - **Compliance + Evals + Webhooks** documentation introduced -- **Stealth guide** (`docs/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration -- **Tunnels guide** (`docs/TUNNELS_GUIDE.md`) — Cloudflare tunnel management -- **Electron guide** (`docs/ELECTRON_GUIDE.md`) — desktop app build + signing +- **Stealth guide** (`docs/security/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration +- **Tunnels guide** (`docs/ops/TUNNELS_GUIDE.md`) — Cloudflare tunnel management +- **Electron guide** (`docs/guides/ELECTRON_GUIDE.md`) — desktop app build + signing ## Links @@ -505,11 +505,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### Documentation Index -- **Architecture & Reference**: `docs/ARCHITECTURE.md`, `docs/CODEBASE_DOCUMENTATION.md`, `docs/REPOSITORY_MAP.md`, `docs/API_REFERENCE.md`, `docs/PROVIDER_REFERENCE.md`, `docs/openapi.yaml` -- **Operator guides**: `docs/USER_GUIDE.md`, `docs/CLI-TOOLS.md`, `docs/TROUBLESHOOTING.md`, `docs/COVERAGE_PLAN.md` -- **Protocols**: `docs/MCP-SERVER.md`, `docs/A2A-SERVER.md`, `docs/AGENT_PROTOCOLS_GUIDE.md`, `docs/CLOUD_AGENT.md` -- **Routing & resilience**: `docs/AUTO-COMBO.md`, `docs/RESILIENCE_GUIDE.md` -- **Security**: `docs/AUTHZ_GUIDE.md`, `docs/GUARDRAILS.md`, `docs/COMPLIANCE.md`, `docs/STEALTH_GUIDE.md` -- **Extensibility**: `docs/SKILLS.md`, `docs/MEMORY.md`, `docs/EVALS.md`, `docs/WEBHOOKS.md`, `docs/REASONING_REPLAY.md` -- **Platform**: `docs/ELECTRON_GUIDE.md`, `docs/TUNNELS_GUIDE.md` +- **Architecture & Reference**: `docs/architecture/ARCHITECTURE.md`, `docs/architecture/CODEBASE_DOCUMENTATION.md`, `docs/architecture/REPOSITORY_MAP.md`, `docs/reference/API_REFERENCE.md`, `docs/reference/PROVIDER_REFERENCE.md`, `docs/reference/openapi.yaml` +- **Operator guides**: `docs/guides/USER_GUIDE.md`, `docs/reference/CLI-TOOLS.md`, `docs/guides/TROUBLESHOOTING.md`, `docs/ops/COVERAGE_PLAN.md` +- **Protocols**: `docs/frameworks/MCP-SERVER.md`, `docs/frameworks/A2A-SERVER.md`, `docs/frameworks/AGENT_PROTOCOLS_GUIDE.md`, `docs/frameworks/CLOUD_AGENT.md` +- **Routing & resilience**: `docs/routing/AUTO-COMBO.md`, `docs/architecture/RESILIENCE_GUIDE.md` +- **Security**: `docs/architecture/AUTHZ_GUIDE.md`, `docs/security/GUARDRAILS.md`, `docs/security/COMPLIANCE.md`, `docs/security/STEALTH_GUIDE.md` +- **Extensibility**: `docs/frameworks/SKILLS.md`, `docs/frameworks/MEMORY.md`, `docs/frameworks/EVALS.md`, `docs/frameworks/WEBHOOKS.md`, `docs/routing/REASONING_REPLAY.md` +- **Platform**: `docs/guides/ELECTRON_GUIDE.md`, `docs/ops/TUNNELS_GUIDE.md` - **AI agents**: `CLAUDE.md`, `AGENTS.md`, `GEMINI.md` diff --git a/docs/i18n/fi/CHANGELOG.md b/docs/i18n/fi/CHANGELOG.md index f7f5a57c95..3b254b82f9 100644 --- a/docs/i18n/fi/CHANGELOG.md +++ b/docs/i18n/fi/CHANGELOG.md @@ -1310,7 +1310,7 @@ We identified that **155 community PRs** across the entire project history (from - **33 New API Key Providers:** Massive provider expansion adding DeepInfra, Vercel AI Gateway, Lambda AI, SambaNova, nScale, OVHcloud AI, Baseten, PublicAI, Moonshot AI, Meta Llama API, v0 (Vercel), Morph, Featherless AI, FriendliAI, LlamaGate, Galadriel, Weights & Biases Inference, Volcengine, AI21 Labs, Venice.ai, Codestral, Upstage, Maritalk, Xiaomi MiMo, Inference.net, NanoGPT, Predibase, Bytez, Heroku AI, Databricks, Snowflake Cortex, and GigaChat (Sber). OmniRoute now supports **100+ providers** (4 Free + 8 OAuth + 91 API Key + Custom compatible) - **Global Email Privacy Toggle:** Added a persistent eye-icon toggle button across all dashboard pages (Providers, Usage Limits, Playground) that reveals or hides masked email addresses. Toggle state is stored in localStorage and synced globally via Zustand store - **Documentation Refresh:** Updated README, ARCHITECTURE, FEATURES, AGENTS.md, and API_REFERENCE for v3.6.2 with accurate provider counts (100+), new executor list, and system API documentation -- **Uninstall Guide:** Created comprehensive `docs/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) +- **Uninstall Guide:** Created comprehensive `docs/guides/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) ### 🐛 Bug Fixes diff --git a/docs/i18n/fi/CONTRIBUTING.md b/docs/i18n/fi/CONTRIBUTING.md index 92e4f26deb..4f717a16e0 100644 --- a/docs/i18n/fi/CONTRIBUTING.md +++ b/docs/i18n/fi/CONTRIBUTING.md @@ -153,7 +153,7 @@ Coverage notes: - If a PR changes production code in `src/`, `open-sse/`, `electron/`, or `bin/`, it must add or update automated tests in the same PR - `npm run coverage:report` prints the detailed file-by-file report from the latest coverage run - `npm run test:coverage:legacy` preserves the older metric for historical comparison -- See `docs/COVERAGE_PLAN.md` for the phased coverage improvement roadmap +- See `docs/ops/COVERAGE_PLAN.md` for the phased coverage improvement roadmap ### Pull Request Requirements @@ -305,7 +305,7 @@ Releases are managed via the `/generate-release` workflow. When a new GitHub Rel ## Getting Help -- **Architecture**: See [`docs/ARCHITECTURE.md`](docs/ARCHITECTURE.md) -- **API Reference**: See [`docs/API_REFERENCE.md`](docs/API_REFERENCE.md) +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](docs/architecture/ARCHITECTURE.md) +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](docs/reference/API_REFERENCE.md) - **Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) - **ADRs**: See `docs/adr/` for architectural decision records diff --git a/docs/i18n/fi/README.md b/docs/i18n/fi/README.md index c74cafde9a..7fb1ace251 100644 --- a/docs/i18n/fi/README.md +++ b/docs/i18n/fi/README.md @@ -2267,25 +2267,25 @@ Se não quiser criar credenciais próprias agora, ainda é possível usar o flux ## Dokumentaatio -| Document | Description | -| -------------------------------------------------------- | --------------------------------------------------- | -| [User Guide](docs/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | -| [API Reference](docs/API_REFERENCE.md) | All endpoints with examples | -| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | -| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | -| [Auto-Combo Engine](docs/AUTO-COMBO.md) | 6-factor scoring, mode packs, self-healing | -| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | -| [Troubleshooting](docs/TROUBLESHOOTING.md) | Common problems and solutions | -| [Architecture](docs/ARCHITECTURE.md) | System architecture and internals | -| [Codebase Documentation](docs/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | -| [Uninstall Guide](docs/UNINSTALL.md) | Clean removal for all install methods | -| [Environment Config](docs/ENVIRONMENT.md) | Complete `.env` variables and references | -| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | -| [OpenAPI Spec](docs/openapi.yaml) | OpenAPI 3.0 specification | -| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | -| [VM Deployment](docs/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | -| [Features Gallery](docs/FEATURES.md) | Visual dashboard tour with screenshots | -| [Release Checklist](docs/RELEASE_CHECKLIST.md) | Pre-release validation steps | +| Document | Description | +| --------------------------------------------------------------------- | --------------------------------------------------- | +| [User Guide](docs/guides/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | +| [API Reference](docs/reference/API_REFERENCE.md) | All endpoints with examples | +| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | +| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | +| [Auto-Combo Engine](docs/routing/AUTO-COMBO.md) | 6-factor scoring, mode packs, self-healing | +| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | +| [Troubleshooting](docs/guides/TROUBLESHOOTING.md) | Common problems and solutions | +| [Architecture](docs/architecture/ARCHITECTURE.md) | System architecture and internals | +| [Codebase Documentation](docs/architecture/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | +| [Uninstall Guide](docs/guides/UNINSTALL.md) | Clean removal for all install methods | +| [Environment Config](docs/reference/ENVIRONMENT.md) | Complete `.env` variables and references | +| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | +| [OpenAPI Spec](docs/reference/openapi.yaml) | OpenAPI 3.0 specification | +| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | +| [VM Deployment](docs/ops/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | +| [Features Gallery](docs/guides/FEATURES.md) | Visual dashboard tour with screenshots | +| [Release Checklist](docs/ops/RELEASE_CHECKLIST.md) | Pre-release validation steps | --- diff --git a/docs/i18n/fi/docs/ARCHITECTURE.md b/docs/i18n/fi/docs/architecture/ARCHITECTURE.md similarity index 100% rename from docs/i18n/fi/docs/ARCHITECTURE.md rename to docs/i18n/fi/docs/architecture/ARCHITECTURE.md diff --git a/docs/i18n/fi/docs/CODEBASE_DOCUMENTATION.md b/docs/i18n/fi/docs/architecture/CODEBASE_DOCUMENTATION.md similarity index 100% rename from docs/i18n/fi/docs/CODEBASE_DOCUMENTATION.md rename to docs/i18n/fi/docs/architecture/CODEBASE_DOCUMENTATION.md diff --git a/docs/i18n/fi/docs/A2A-SERVER.md b/docs/i18n/fi/docs/frameworks/A2A-SERVER.md similarity index 100% rename from docs/i18n/fi/docs/A2A-SERVER.md rename to docs/i18n/fi/docs/frameworks/A2A-SERVER.md diff --git a/docs/i18n/fi/docs/MCP-SERVER.md b/docs/i18n/fi/docs/frameworks/MCP-SERVER.md similarity index 100% rename from docs/i18n/fi/docs/MCP-SERVER.md rename to docs/i18n/fi/docs/frameworks/MCP-SERVER.md diff --git a/docs/i18n/fi/docs/FEATURES.md b/docs/i18n/fi/docs/guides/FEATURES.md similarity index 100% rename from docs/i18n/fi/docs/FEATURES.md rename to docs/i18n/fi/docs/guides/FEATURES.md diff --git a/docs/i18n/fi/docs/I18N.md b/docs/i18n/fi/docs/guides/I18N.md similarity index 99% rename from docs/i18n/fi/docs/I18N.md rename to docs/i18n/fi/docs/guides/I18N.md index 7ef69aba8f..f75d692c16 100644 --- a/docs/i18n/fi/docs/I18N.md +++ b/docs/i18n/fi/docs/guides/I18N.md @@ -420,7 +420,7 @@ The generator originally used `code: "in"` (deprecated Google Translate code) fo ### `docs/i18n/README.md` Is Auto-Generated -The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/I18N.md` (this file) for hand-written documentation that should persist. +The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/guides/I18N.md` (this file) for hand-written documentation that should persist. ### External Untranslatable Keys List diff --git a/docs/i18n/fi/docs/TROUBLESHOOTING.md b/docs/i18n/fi/docs/guides/TROUBLESHOOTING.md similarity index 98% rename from docs/i18n/fi/docs/TROUBLESHOOTING.md rename to docs/i18n/fi/docs/guides/TROUBLESHOOTING.md index a4a2994239..52ebbb2a8d 100644 --- a/docs/i18n/fi/docs/TROUBLESHOOTING.md +++ b/docs/i18n/fi/docs/guides/TROUBLESHOOTING.md @@ -335,7 +335,7 @@ You can ignore this section if you do not run RAG or agent pipelines behind Omni ## Still Stuck? - **GitHub Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) -- **Architecture**: See [`docs/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details -- **API Reference**: See [`docs/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints - **Health Dashboard**: Check **Dashboard → Health** for real-time system status - **Translator**: Use **Dashboard → Translator** to debug format issues diff --git a/docs/i18n/fi/docs/UNINSTALL.md b/docs/i18n/fi/docs/guides/UNINSTALL.md similarity index 100% rename from docs/i18n/fi/docs/UNINSTALL.md rename to docs/i18n/fi/docs/guides/UNINSTALL.md diff --git a/docs/i18n/fi/docs/USER_GUIDE.md b/docs/i18n/fi/docs/guides/USER_GUIDE.md similarity index 100% rename from docs/i18n/fi/docs/USER_GUIDE.md rename to docs/i18n/fi/docs/guides/USER_GUIDE.md diff --git a/docs/i18n/fi/docs/COVERAGE_PLAN.md b/docs/i18n/fi/docs/ops/COVERAGE_PLAN.md similarity index 100% rename from docs/i18n/fi/docs/COVERAGE_PLAN.md rename to docs/i18n/fi/docs/ops/COVERAGE_PLAN.md diff --git a/docs/i18n/fi/docs/FLY_IO_DEPLOYMENT_GUIDE.md b/docs/i18n/fi/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/fi/docs/FLY_IO_DEPLOYMENT_GUIDE.md rename to docs/i18n/fi/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/fi/docs/RELEASE_CHECKLIST.md b/docs/i18n/fi/docs/ops/RELEASE_CHECKLIST.md similarity index 94% rename from docs/i18n/fi/docs/RELEASE_CHECKLIST.md rename to docs/i18n/fi/docs/ops/RELEASE_CHECKLIST.md index a83ed9f9f2..12ae28efb8 100644 --- a/docs/i18n/fi/docs/RELEASE_CHECKLIST.md +++ b/docs/i18n/fi/docs/ops/RELEASE_CHECKLIST.md @@ -16,14 +16,14 @@ Use this checklist before tagging or publishing a new OmniRoute release. ## API Docs -1. Update `docs/openapi.yaml`: +1. Update `docs/reference/openapi.yaml`: - `info.version` must equal `package.json` version. 2. Validate endpoint examples if API contracts changed. ## Runtime Docs -1. Review `docs/ARCHITECTURE.md` for storage/runtime drift. -2. Review `docs/TROUBLESHOOTING.md` for env var and operational drift. +1. Review `docs/architecture/ARCHITECTURE.md` for storage/runtime drift. +2. Review `docs/guides/TROUBLESHOOTING.md` for env var and operational drift. 3. Verify the release/runtime Node.js version still satisfies the supported secure floor: - `>=20.20.2 <21` or `>=22.22.2 <23` - `npm run check:node-runtime` diff --git a/docs/i18n/fi/docs/VM_DEPLOYMENT_GUIDE.md b/docs/i18n/fi/docs/ops/VM_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/fi/docs/VM_DEPLOYMENT_GUIDE.md rename to docs/i18n/fi/docs/ops/VM_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/fi/docs/API_REFERENCE.md b/docs/i18n/fi/docs/reference/API_REFERENCE.md similarity index 100% rename from docs/i18n/fi/docs/API_REFERENCE.md rename to docs/i18n/fi/docs/reference/API_REFERENCE.md diff --git a/docs/i18n/fi/docs/CLI-TOOLS.md b/docs/i18n/fi/docs/reference/CLI-TOOLS.md similarity index 100% rename from docs/i18n/fi/docs/CLI-TOOLS.md rename to docs/i18n/fi/docs/reference/CLI-TOOLS.md diff --git a/docs/i18n/fi/docs/ENVIRONMENT.md b/docs/i18n/fi/docs/reference/ENVIRONMENT.md similarity index 100% rename from docs/i18n/fi/docs/ENVIRONMENT.md rename to docs/i18n/fi/docs/reference/ENVIRONMENT.md diff --git a/docs/i18n/fi/docs/AUTO-COMBO.md b/docs/i18n/fi/docs/routing/AUTO-COMBO.md similarity index 100% rename from docs/i18n/fi/docs/AUTO-COMBO.md rename to docs/i18n/fi/docs/routing/AUTO-COMBO.md diff --git a/docs/i18n/fi/llm.txt b/docs/i18n/fi/llm.txt index 3b8fd6ceb2..d955612ef5 100644 --- a/docs/i18n/fi/llm.txt +++ b/docs/i18n/fi/llm.txt @@ -357,11 +357,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### MCP Server (37 Tools) | Category | Tools | |------------|-------| -| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/MCP-SERVER.md` for full inventory) | +| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/frameworks/MCP-SERVER.md` for full inventory) | | Memory (3) | `memory_search`, `memory_add`, `memory_clear` | | Skills (4) | `skills_list`, `skills_enable`, `skills_execute`, `skills_executions` | -**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/MCP-SERVER.md`. +**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/frameworks/MCP-SERVER.md`. ### Provider Categories @@ -472,7 +472,7 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo 20. **Guardrails framework** in `src/lib/guardrails/` — hot-reloadable registry. Built-ins (priority-ordered): `vision-bridge` (5) → `pii-masker` (10) → `prompt-injection` (20). Fail-open model: exceptions never block traffic. Per-request opt-out via `x-omniroute-disabled-guardrails` header. -21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/AUTHZ_GUIDE.md`. +21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/architecture/AUTHZ_GUIDE.md`. 22. **Three resilience layers** are distinct (do not conflate them): - **Provider Circuit Breaker** (`src/shared/utils/circuitBreaker.ts`) — whole-provider scope. @@ -489,11 +489,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo - **MCP server expanded to 37 tools** (30 base + 3 memory + 4 skills) across ~13 scopes - **OAuth providers expanded to 14**: added Qwen, Kiro, Qoder, Gemini, Windsurf, GitLab Duo - **Coverage gate raised to 75/75/75/70** (was 60% across the board) — measured ~82% -- **Reasoning replay** (`docs/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams +- **Reasoning replay** (`docs/routing/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams - **Compliance + Evals + Webhooks** documentation introduced -- **Stealth guide** (`docs/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration -- **Tunnels guide** (`docs/TUNNELS_GUIDE.md`) — Cloudflare tunnel management -- **Electron guide** (`docs/ELECTRON_GUIDE.md`) — desktop app build + signing +- **Stealth guide** (`docs/security/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration +- **Tunnels guide** (`docs/ops/TUNNELS_GUIDE.md`) — Cloudflare tunnel management +- **Electron guide** (`docs/guides/ELECTRON_GUIDE.md`) — desktop app build + signing ## Links @@ -505,11 +505,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### Documentation Index -- **Architecture & Reference**: `docs/ARCHITECTURE.md`, `docs/CODEBASE_DOCUMENTATION.md`, `docs/REPOSITORY_MAP.md`, `docs/API_REFERENCE.md`, `docs/PROVIDER_REFERENCE.md`, `docs/openapi.yaml` -- **Operator guides**: `docs/USER_GUIDE.md`, `docs/CLI-TOOLS.md`, `docs/TROUBLESHOOTING.md`, `docs/COVERAGE_PLAN.md` -- **Protocols**: `docs/MCP-SERVER.md`, `docs/A2A-SERVER.md`, `docs/AGENT_PROTOCOLS_GUIDE.md`, `docs/CLOUD_AGENT.md` -- **Routing & resilience**: `docs/AUTO-COMBO.md`, `docs/RESILIENCE_GUIDE.md` -- **Security**: `docs/AUTHZ_GUIDE.md`, `docs/GUARDRAILS.md`, `docs/COMPLIANCE.md`, `docs/STEALTH_GUIDE.md` -- **Extensibility**: `docs/SKILLS.md`, `docs/MEMORY.md`, `docs/EVALS.md`, `docs/WEBHOOKS.md`, `docs/REASONING_REPLAY.md` -- **Platform**: `docs/ELECTRON_GUIDE.md`, `docs/TUNNELS_GUIDE.md` +- **Architecture & Reference**: `docs/architecture/ARCHITECTURE.md`, `docs/architecture/CODEBASE_DOCUMENTATION.md`, `docs/architecture/REPOSITORY_MAP.md`, `docs/reference/API_REFERENCE.md`, `docs/reference/PROVIDER_REFERENCE.md`, `docs/reference/openapi.yaml` +- **Operator guides**: `docs/guides/USER_GUIDE.md`, `docs/reference/CLI-TOOLS.md`, `docs/guides/TROUBLESHOOTING.md`, `docs/ops/COVERAGE_PLAN.md` +- **Protocols**: `docs/frameworks/MCP-SERVER.md`, `docs/frameworks/A2A-SERVER.md`, `docs/frameworks/AGENT_PROTOCOLS_GUIDE.md`, `docs/frameworks/CLOUD_AGENT.md` +- **Routing & resilience**: `docs/routing/AUTO-COMBO.md`, `docs/architecture/RESILIENCE_GUIDE.md` +- **Security**: `docs/architecture/AUTHZ_GUIDE.md`, `docs/security/GUARDRAILS.md`, `docs/security/COMPLIANCE.md`, `docs/security/STEALTH_GUIDE.md` +- **Extensibility**: `docs/frameworks/SKILLS.md`, `docs/frameworks/MEMORY.md`, `docs/frameworks/EVALS.md`, `docs/frameworks/WEBHOOKS.md`, `docs/routing/REASONING_REPLAY.md` +- **Platform**: `docs/guides/ELECTRON_GUIDE.md`, `docs/ops/TUNNELS_GUIDE.md` - **AI agents**: `CLAUDE.md`, `AGENTS.md`, `GEMINI.md` diff --git a/docs/i18n/fr/CHANGELOG.md b/docs/i18n/fr/CHANGELOG.md index 14f650e21f..280428cc05 100644 --- a/docs/i18n/fr/CHANGELOG.md +++ b/docs/i18n/fr/CHANGELOG.md @@ -1310,7 +1310,7 @@ We identified that **155 community PRs** across the entire project history (from - **33 New API Key Providers:** Massive provider expansion adding DeepInfra, Vercel AI Gateway, Lambda AI, SambaNova, nScale, OVHcloud AI, Baseten, PublicAI, Moonshot AI, Meta Llama API, v0 (Vercel), Morph, Featherless AI, FriendliAI, LlamaGate, Galadriel, Weights & Biases Inference, Volcengine, AI21 Labs, Venice.ai, Codestral, Upstage, Maritalk, Xiaomi MiMo, Inference.net, NanoGPT, Predibase, Bytez, Heroku AI, Databricks, Snowflake Cortex, and GigaChat (Sber). OmniRoute now supports **100+ providers** (4 Free + 8 OAuth + 91 API Key + Custom compatible) - **Global Email Privacy Toggle:** Added a persistent eye-icon toggle button across all dashboard pages (Providers, Usage Limits, Playground) that reveals or hides masked email addresses. Toggle state is stored in localStorage and synced globally via Zustand store - **Documentation Refresh:** Updated README, ARCHITECTURE, FEATURES, AGENTS.md, and API_REFERENCE for v3.6.2 with accurate provider counts (100+), new executor list, and system API documentation -- **Uninstall Guide:** Created comprehensive `docs/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) +- **Uninstall Guide:** Created comprehensive `docs/guides/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) ### 🐛 Bug Fixes diff --git a/docs/i18n/fr/CONTRIBUTING.md b/docs/i18n/fr/CONTRIBUTING.md index 01170fa187..53d22d8c58 100644 --- a/docs/i18n/fr/CONTRIBUTING.md +++ b/docs/i18n/fr/CONTRIBUTING.md @@ -153,7 +153,7 @@ Coverage notes: - If a PR changes production code in `src/`, `open-sse/`, `electron/`, or `bin/`, it must add or update automated tests in the same PR - `npm run coverage:report` prints the detailed file-by-file report from the latest coverage run - `npm run test:coverage:legacy` preserves the older metric for historical comparison -- See `docs/COVERAGE_PLAN.md` for the phased coverage improvement roadmap +- See `docs/ops/COVERAGE_PLAN.md` for the phased coverage improvement roadmap ### Pull Request Requirements @@ -305,7 +305,7 @@ Releases are managed via the `/generate-release` workflow. When a new GitHub Rel ## Getting Help -- **Architecture**: See [`docs/ARCHITECTURE.md`](docs/ARCHITECTURE.md) -- **API Reference**: See [`docs/API_REFERENCE.md`](docs/API_REFERENCE.md) +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](docs/architecture/ARCHITECTURE.md) +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](docs/reference/API_REFERENCE.md) - **Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) - **ADRs**: See `docs/adr/` for architectural decision records diff --git a/docs/i18n/fr/README.md b/docs/i18n/fr/README.md index 8648ea364e..4621a0d668 100644 --- a/docs/i18n/fr/README.md +++ b/docs/i18n/fr/README.md @@ -2267,25 +2267,25 @@ Se não quiser criar credenciais próprias agora, ainda é possível usar o flux ## Documentation -| Document | Description | -| -------------------------------------------------------- | --------------------------------------------------- | -| [User Guide](docs/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | -| [API Reference](docs/API_REFERENCE.md) | All endpoints with examples | -| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | -| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | -| [Auto-Combo Engine](docs/AUTO-COMBO.md) | 6-factor scoring, mode packs, self-healing | -| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | -| [Troubleshooting](docs/TROUBLESHOOTING.md) | Common problems and solutions | -| [Architecture](docs/ARCHITECTURE.md) | System architecture and internals | -| [Codebase Documentation](docs/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | -| [Uninstall Guide](docs/UNINSTALL.md) | Clean removal for all install methods | -| [Environment Config](docs/ENVIRONMENT.md) | Complete `.env` variables and references | -| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | -| [OpenAPI Spec](docs/openapi.yaml) | OpenAPI 3.0 specification | -| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | -| [VM Deployment](docs/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | -| [Features Gallery](docs/FEATURES.md) | Visual dashboard tour with screenshots | -| [Release Checklist](docs/RELEASE_CHECKLIST.md) | Pre-release validation steps | +| Document | Description | +| --------------------------------------------------------------------- | --------------------------------------------------- | +| [User Guide](docs/guides/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | +| [API Reference](docs/reference/API_REFERENCE.md) | All endpoints with examples | +| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | +| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | +| [Auto-Combo Engine](docs/routing/AUTO-COMBO.md) | 6-factor scoring, mode packs, self-healing | +| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | +| [Troubleshooting](docs/guides/TROUBLESHOOTING.md) | Common problems and solutions | +| [Architecture](docs/architecture/ARCHITECTURE.md) | System architecture and internals | +| [Codebase Documentation](docs/architecture/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | +| [Uninstall Guide](docs/guides/UNINSTALL.md) | Clean removal for all install methods | +| [Environment Config](docs/reference/ENVIRONMENT.md) | Complete `.env` variables and references | +| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | +| [OpenAPI Spec](docs/reference/openapi.yaml) | OpenAPI 3.0 specification | +| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | +| [VM Deployment](docs/ops/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | +| [Features Gallery](docs/guides/FEATURES.md) | Visual dashboard tour with screenshots | +| [Release Checklist](docs/ops/RELEASE_CHECKLIST.md) | Pre-release validation steps | --- diff --git a/docs/i18n/fr/docs/ARCHITECTURE.md b/docs/i18n/fr/docs/architecture/ARCHITECTURE.md similarity index 100% rename from docs/i18n/fr/docs/ARCHITECTURE.md rename to docs/i18n/fr/docs/architecture/ARCHITECTURE.md diff --git a/docs/i18n/fr/docs/CODEBASE_DOCUMENTATION.md b/docs/i18n/fr/docs/architecture/CODEBASE_DOCUMENTATION.md similarity index 100% rename from docs/i18n/fr/docs/CODEBASE_DOCUMENTATION.md rename to docs/i18n/fr/docs/architecture/CODEBASE_DOCUMENTATION.md diff --git a/docs/i18n/fr/docs/A2A-SERVER.md b/docs/i18n/fr/docs/frameworks/A2A-SERVER.md similarity index 100% rename from docs/i18n/fr/docs/A2A-SERVER.md rename to docs/i18n/fr/docs/frameworks/A2A-SERVER.md diff --git a/docs/i18n/fr/docs/MCP-SERVER.md b/docs/i18n/fr/docs/frameworks/MCP-SERVER.md similarity index 100% rename from docs/i18n/fr/docs/MCP-SERVER.md rename to docs/i18n/fr/docs/frameworks/MCP-SERVER.md diff --git a/docs/i18n/fr/docs/FEATURES.md b/docs/i18n/fr/docs/guides/FEATURES.md similarity index 100% rename from docs/i18n/fr/docs/FEATURES.md rename to docs/i18n/fr/docs/guides/FEATURES.md diff --git a/docs/i18n/fr/docs/I18N.md b/docs/i18n/fr/docs/guides/I18N.md similarity index 99% rename from docs/i18n/fr/docs/I18N.md rename to docs/i18n/fr/docs/guides/I18N.md index 6e3741d440..2e7c2f2451 100644 --- a/docs/i18n/fr/docs/I18N.md +++ b/docs/i18n/fr/docs/guides/I18N.md @@ -420,7 +420,7 @@ The generator originally used `code: "in"` (deprecated Google Translate code) fo ### `docs/i18n/README.md` Is Auto-Generated -The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/I18N.md` (this file) for hand-written documentation that should persist. +The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/guides/I18N.md` (this file) for hand-written documentation that should persist. ### External Untranslatable Keys List diff --git a/docs/i18n/fr/docs/TROUBLESHOOTING.md b/docs/i18n/fr/docs/guides/TROUBLESHOOTING.md similarity index 98% rename from docs/i18n/fr/docs/TROUBLESHOOTING.md rename to docs/i18n/fr/docs/guides/TROUBLESHOOTING.md index 8f6f96dc22..b5483677da 100644 --- a/docs/i18n/fr/docs/TROUBLESHOOTING.md +++ b/docs/i18n/fr/docs/guides/TROUBLESHOOTING.md @@ -335,7 +335,7 @@ You can ignore this section if you do not run RAG or agent pipelines behind Omni ## Still Stuck? - **GitHub Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) -- **Architecture**: See [`docs/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details -- **API Reference**: See [`docs/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints - **Health Dashboard**: Check **Dashboard → Health** for real-time system status - **Translator**: Use **Dashboard → Translator** to debug format issues diff --git a/docs/i18n/fr/docs/UNINSTALL.md b/docs/i18n/fr/docs/guides/UNINSTALL.md similarity index 100% rename from docs/i18n/fr/docs/UNINSTALL.md rename to docs/i18n/fr/docs/guides/UNINSTALL.md diff --git a/docs/i18n/fr/docs/USER_GUIDE.md b/docs/i18n/fr/docs/guides/USER_GUIDE.md similarity index 100% rename from docs/i18n/fr/docs/USER_GUIDE.md rename to docs/i18n/fr/docs/guides/USER_GUIDE.md diff --git a/docs/i18n/fr/docs/COVERAGE_PLAN.md b/docs/i18n/fr/docs/ops/COVERAGE_PLAN.md similarity index 100% rename from docs/i18n/fr/docs/COVERAGE_PLAN.md rename to docs/i18n/fr/docs/ops/COVERAGE_PLAN.md diff --git a/docs/i18n/fr/docs/FLY_IO_DEPLOYMENT_GUIDE.md b/docs/i18n/fr/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/fr/docs/FLY_IO_DEPLOYMENT_GUIDE.md rename to docs/i18n/fr/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/fr/docs/RELEASE_CHECKLIST.md b/docs/i18n/fr/docs/ops/RELEASE_CHECKLIST.md similarity index 94% rename from docs/i18n/fr/docs/RELEASE_CHECKLIST.md rename to docs/i18n/fr/docs/ops/RELEASE_CHECKLIST.md index 060f96aed5..d0e8d91740 100644 --- a/docs/i18n/fr/docs/RELEASE_CHECKLIST.md +++ b/docs/i18n/fr/docs/ops/RELEASE_CHECKLIST.md @@ -16,14 +16,14 @@ Use this checklist before tagging or publishing a new OmniRoute release. ## API Docs -1. Update `docs/openapi.yaml`: +1. Update `docs/reference/openapi.yaml`: - `info.version` must equal `package.json` version. 2. Validate endpoint examples if API contracts changed. ## Runtime Docs -1. Review `docs/ARCHITECTURE.md` for storage/runtime drift. -2. Review `docs/TROUBLESHOOTING.md` for env var and operational drift. +1. Review `docs/architecture/ARCHITECTURE.md` for storage/runtime drift. +2. Review `docs/guides/TROUBLESHOOTING.md` for env var and operational drift. 3. Verify the release/runtime Node.js version still satisfies the supported secure floor: - `>=20.20.2 <21` or `>=22.22.2 <23` - `npm run check:node-runtime` diff --git a/docs/i18n/fr/docs/VM_DEPLOYMENT_GUIDE.md b/docs/i18n/fr/docs/ops/VM_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/fr/docs/VM_DEPLOYMENT_GUIDE.md rename to docs/i18n/fr/docs/ops/VM_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/fr/docs/API_REFERENCE.md b/docs/i18n/fr/docs/reference/API_REFERENCE.md similarity index 100% rename from docs/i18n/fr/docs/API_REFERENCE.md rename to docs/i18n/fr/docs/reference/API_REFERENCE.md diff --git a/docs/i18n/fr/docs/CLI-TOOLS.md b/docs/i18n/fr/docs/reference/CLI-TOOLS.md similarity index 100% rename from docs/i18n/fr/docs/CLI-TOOLS.md rename to docs/i18n/fr/docs/reference/CLI-TOOLS.md diff --git a/docs/i18n/fr/docs/ENVIRONMENT.md b/docs/i18n/fr/docs/reference/ENVIRONMENT.md similarity index 100% rename from docs/i18n/fr/docs/ENVIRONMENT.md rename to docs/i18n/fr/docs/reference/ENVIRONMENT.md diff --git a/docs/i18n/fr/docs/AUTO-COMBO.md b/docs/i18n/fr/docs/routing/AUTO-COMBO.md similarity index 100% rename from docs/i18n/fr/docs/AUTO-COMBO.md rename to docs/i18n/fr/docs/routing/AUTO-COMBO.md diff --git a/docs/i18n/fr/llm.txt b/docs/i18n/fr/llm.txt index 3805843928..d7605da05a 100644 --- a/docs/i18n/fr/llm.txt +++ b/docs/i18n/fr/llm.txt @@ -357,11 +357,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### MCP Server (37 Tools) | Category | Tools | |------------|-------| -| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/MCP-SERVER.md` for full inventory) | +| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/frameworks/MCP-SERVER.md` for full inventory) | | Memory (3) | `memory_search`, `memory_add`, `memory_clear` | | Skills (4) | `skills_list`, `skills_enable`, `skills_execute`, `skills_executions` | -**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/MCP-SERVER.md`. +**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/frameworks/MCP-SERVER.md`. ### Provider Categories @@ -472,7 +472,7 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo 20. **Guardrails framework** in `src/lib/guardrails/` — hot-reloadable registry. Built-ins (priority-ordered): `vision-bridge` (5) → `pii-masker` (10) → `prompt-injection` (20). Fail-open model: exceptions never block traffic. Per-request opt-out via `x-omniroute-disabled-guardrails` header. -21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/AUTHZ_GUIDE.md`. +21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/architecture/AUTHZ_GUIDE.md`. 22. **Three resilience layers** are distinct (do not conflate them): - **Provider Circuit Breaker** (`src/shared/utils/circuitBreaker.ts`) — whole-provider scope. @@ -489,11 +489,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo - **MCP server expanded to 37 tools** (30 base + 3 memory + 4 skills) across ~13 scopes - **OAuth providers expanded to 14**: added Qwen, Kiro, Qoder, Gemini, Windsurf, GitLab Duo - **Coverage gate raised to 75/75/75/70** (was 60% across the board) — measured ~82% -- **Reasoning replay** (`docs/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams +- **Reasoning replay** (`docs/routing/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams - **Compliance + Evals + Webhooks** documentation introduced -- **Stealth guide** (`docs/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration -- **Tunnels guide** (`docs/TUNNELS_GUIDE.md`) — Cloudflare tunnel management -- **Electron guide** (`docs/ELECTRON_GUIDE.md`) — desktop app build + signing +- **Stealth guide** (`docs/security/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration +- **Tunnels guide** (`docs/ops/TUNNELS_GUIDE.md`) — Cloudflare tunnel management +- **Electron guide** (`docs/guides/ELECTRON_GUIDE.md`) — desktop app build + signing ## Links @@ -505,11 +505,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### Documentation Index -- **Architecture & Reference**: `docs/ARCHITECTURE.md`, `docs/CODEBASE_DOCUMENTATION.md`, `docs/REPOSITORY_MAP.md`, `docs/API_REFERENCE.md`, `docs/PROVIDER_REFERENCE.md`, `docs/openapi.yaml` -- **Operator guides**: `docs/USER_GUIDE.md`, `docs/CLI-TOOLS.md`, `docs/TROUBLESHOOTING.md`, `docs/COVERAGE_PLAN.md` -- **Protocols**: `docs/MCP-SERVER.md`, `docs/A2A-SERVER.md`, `docs/AGENT_PROTOCOLS_GUIDE.md`, `docs/CLOUD_AGENT.md` -- **Routing & resilience**: `docs/AUTO-COMBO.md`, `docs/RESILIENCE_GUIDE.md` -- **Security**: `docs/AUTHZ_GUIDE.md`, `docs/GUARDRAILS.md`, `docs/COMPLIANCE.md`, `docs/STEALTH_GUIDE.md` -- **Extensibility**: `docs/SKILLS.md`, `docs/MEMORY.md`, `docs/EVALS.md`, `docs/WEBHOOKS.md`, `docs/REASONING_REPLAY.md` -- **Platform**: `docs/ELECTRON_GUIDE.md`, `docs/TUNNELS_GUIDE.md` +- **Architecture & Reference**: `docs/architecture/ARCHITECTURE.md`, `docs/architecture/CODEBASE_DOCUMENTATION.md`, `docs/architecture/REPOSITORY_MAP.md`, `docs/reference/API_REFERENCE.md`, `docs/reference/PROVIDER_REFERENCE.md`, `docs/reference/openapi.yaml` +- **Operator guides**: `docs/guides/USER_GUIDE.md`, `docs/reference/CLI-TOOLS.md`, `docs/guides/TROUBLESHOOTING.md`, `docs/ops/COVERAGE_PLAN.md` +- **Protocols**: `docs/frameworks/MCP-SERVER.md`, `docs/frameworks/A2A-SERVER.md`, `docs/frameworks/AGENT_PROTOCOLS_GUIDE.md`, `docs/frameworks/CLOUD_AGENT.md` +- **Routing & resilience**: `docs/routing/AUTO-COMBO.md`, `docs/architecture/RESILIENCE_GUIDE.md` +- **Security**: `docs/architecture/AUTHZ_GUIDE.md`, `docs/security/GUARDRAILS.md`, `docs/security/COMPLIANCE.md`, `docs/security/STEALTH_GUIDE.md` +- **Extensibility**: `docs/frameworks/SKILLS.md`, `docs/frameworks/MEMORY.md`, `docs/frameworks/EVALS.md`, `docs/frameworks/WEBHOOKS.md`, `docs/routing/REASONING_REPLAY.md` +- **Platform**: `docs/guides/ELECTRON_GUIDE.md`, `docs/ops/TUNNELS_GUIDE.md` - **AI agents**: `CLAUDE.md`, `AGENTS.md`, `GEMINI.md` diff --git a/docs/i18n/gu/CHANGELOG.md b/docs/i18n/gu/CHANGELOG.md index 2349d186b8..ff126fc75f 100644 --- a/docs/i18n/gu/CHANGELOG.md +++ b/docs/i18n/gu/CHANGELOG.md @@ -1310,7 +1310,7 @@ We identified that **155 community PRs** across the entire project history (from - **33 New API Key Providers:** Massive provider expansion adding DeepInfra, Vercel AI Gateway, Lambda AI, SambaNova, nScale, OVHcloud AI, Baseten, PublicAI, Moonshot AI, Meta Llama API, v0 (Vercel), Morph, Featherless AI, FriendliAI, LlamaGate, Galadriel, Weights & Biases Inference, Volcengine, AI21 Labs, Venice.ai, Codestral, Upstage, Maritalk, Xiaomi MiMo, Inference.net, NanoGPT, Predibase, Bytez, Heroku AI, Databricks, Snowflake Cortex, and GigaChat (Sber). OmniRoute now supports **100+ providers** (4 Free + 8 OAuth + 91 API Key + Custom compatible) - **Global Email Privacy Toggle:** Added a persistent eye-icon toggle button across all dashboard pages (Providers, Usage Limits, Playground) that reveals or hides masked email addresses. Toggle state is stored in localStorage and synced globally via Zustand store - **Documentation Refresh:** Updated README, ARCHITECTURE, FEATURES, AGENTS.md, and API_REFERENCE for v3.6.2 with accurate provider counts (100+), new executor list, and system API documentation -- **Uninstall Guide:** Created comprehensive `docs/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) +- **Uninstall Guide:** Created comprehensive `docs/guides/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) ### 🐛 Bug Fixes diff --git a/docs/i18n/gu/CONTRIBUTING.md b/docs/i18n/gu/CONTRIBUTING.md index 18ee49601d..e59338a470 100644 --- a/docs/i18n/gu/CONTRIBUTING.md +++ b/docs/i18n/gu/CONTRIBUTING.md @@ -153,7 +153,7 @@ Coverage notes: - If a PR changes production code in `src/`, `open-sse/`, `electron/`, or `bin/`, it must add or update automated tests in the same PR - `npm run coverage:report` prints the detailed file-by-file report from the latest coverage run - `npm run test:coverage:legacy` preserves the older metric for historical comparison -- See `docs/COVERAGE_PLAN.md` for the phased coverage improvement roadmap +- See `docs/ops/COVERAGE_PLAN.md` for the phased coverage improvement roadmap ### Pull Request Requirements @@ -305,7 +305,7 @@ Releases are managed via the `/generate-release` workflow. When a new GitHub Rel ## Getting Help -- **Architecture**: See [`docs/ARCHITECTURE.md`](docs/ARCHITECTURE.md) -- **API Reference**: See [`docs/API_REFERENCE.md`](docs/API_REFERENCE.md) +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](docs/architecture/ARCHITECTURE.md) +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](docs/reference/API_REFERENCE.md) - **Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) - **ADRs**: See `docs/adr/` for architectural decision records diff --git a/docs/i18n/gu/README.md b/docs/i18n/gu/README.md index 000aa2895c..ab7af0355a 100644 --- a/docs/i18n/gu/README.md +++ b/docs/i18n/gu/README.md @@ -2267,25 +2267,25 @@ Se não quiser criar credenciais próprias agora, ainda é possível usar o flux ## Documentación -| Document | Description | -| -------------------------------------------------------- | --------------------------------------------------- | -| [User Guide](docs/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | -| [API Reference](docs/API_REFERENCE.md) | All endpoints with examples | -| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | -| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | -| [Auto-Combo Engine](docs/auto-combo.md) | 6-factor scoring, mode packs, self-healing | -| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | -| [Troubleshooting](docs/TROUBLESHOOTING.md) | Common problems and solutions | -| [Architecture](docs/ARCHITECTURE.md) | System architecture and internals | -| [Codebase Documentation](docs/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | -| [Uninstall Guide](docs/UNINSTALL.md) | Clean removal for all install methods | -| [Environment Config](docs/ENVIRONMENT.md) | Complete `.env` variables and references | -| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | -| [OpenAPI Spec](docs/openapi.yaml) | OpenAPI 3.0 specification | -| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | -| [VM Deployment](docs/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | -| [Features Gallery](docs/FEATURES.md) | Visual dashboard tour with screenshots | -| [Release Checklist](docs/RELEASE_CHECKLIST.md) | Pre-release validation steps | +| Document | Description | +| --------------------------------------------------------------------- | --------------------------------------------------- | +| [User Guide](docs/guides/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | +| [API Reference](docs/reference/API_REFERENCE.md) | All endpoints with examples | +| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | +| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | +| [Auto-Combo Engine](docs/auto-combo.md) | 6-factor scoring, mode packs, self-healing | +| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | +| [Troubleshooting](docs/guides/TROUBLESHOOTING.md) | Common problems and solutions | +| [Architecture](docs/architecture/ARCHITECTURE.md) | System architecture and internals | +| [Codebase Documentation](docs/architecture/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | +| [Uninstall Guide](docs/guides/UNINSTALL.md) | Clean removal for all install methods | +| [Environment Config](docs/reference/ENVIRONMENT.md) | Complete `.env` variables and references | +| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | +| [OpenAPI Spec](docs/reference/openapi.yaml) | OpenAPI 3.0 specification | +| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | +| [VM Deployment](docs/ops/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | +| [Features Gallery](docs/guides/FEATURES.md) | Visual dashboard tour with screenshots | +| [Release Checklist](docs/ops/RELEASE_CHECKLIST.md) | Pre-release validation steps | --- diff --git a/docs/i18n/gu/docs/ARCHITECTURE.md b/docs/i18n/gu/docs/architecture/ARCHITECTURE.md similarity index 100% rename from docs/i18n/gu/docs/ARCHITECTURE.md rename to docs/i18n/gu/docs/architecture/ARCHITECTURE.md diff --git a/docs/i18n/gu/docs/CODEBASE_DOCUMENTATION.md b/docs/i18n/gu/docs/architecture/CODEBASE_DOCUMENTATION.md similarity index 100% rename from docs/i18n/gu/docs/CODEBASE_DOCUMENTATION.md rename to docs/i18n/gu/docs/architecture/CODEBASE_DOCUMENTATION.md diff --git a/docs/i18n/gu/docs/A2A-SERVER.md b/docs/i18n/gu/docs/frameworks/A2A-SERVER.md similarity index 100% rename from docs/i18n/gu/docs/A2A-SERVER.md rename to docs/i18n/gu/docs/frameworks/A2A-SERVER.md diff --git a/docs/i18n/gu/docs/MCP-SERVER.md b/docs/i18n/gu/docs/frameworks/MCP-SERVER.md similarity index 100% rename from docs/i18n/gu/docs/MCP-SERVER.md rename to docs/i18n/gu/docs/frameworks/MCP-SERVER.md diff --git a/docs/i18n/gu/docs/FEATURES.md b/docs/i18n/gu/docs/guides/FEATURES.md similarity index 100% rename from docs/i18n/gu/docs/FEATURES.md rename to docs/i18n/gu/docs/guides/FEATURES.md diff --git a/docs/i18n/gu/docs/I18N.md b/docs/i18n/gu/docs/guides/I18N.md similarity index 99% rename from docs/i18n/gu/docs/I18N.md rename to docs/i18n/gu/docs/guides/I18N.md index 5888d16a6b..9c5d55e353 100644 --- a/docs/i18n/gu/docs/I18N.md +++ b/docs/i18n/gu/docs/guides/I18N.md @@ -420,7 +420,7 @@ The generator originally used `code: "in"` (deprecated Google Translate code) fo ### `docs/i18n/README.md` Is Auto-Generated -The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/I18N.md` (this file) for hand-written documentation that should persist. +The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/guides/I18N.md` (this file) for hand-written documentation that should persist. ### External Untranslatable Keys List diff --git a/docs/i18n/gu/docs/TROUBLESHOOTING.md b/docs/i18n/gu/docs/guides/TROUBLESHOOTING.md similarity index 98% rename from docs/i18n/gu/docs/TROUBLESHOOTING.md rename to docs/i18n/gu/docs/guides/TROUBLESHOOTING.md index 5d46baabbe..72735de524 100644 --- a/docs/i18n/gu/docs/TROUBLESHOOTING.md +++ b/docs/i18n/gu/docs/guides/TROUBLESHOOTING.md @@ -335,7 +335,7 @@ You can ignore this section if you do not run RAG or agent pipelines behind Omni ## Still Stuck? - **GitHub Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) -- **Architecture**: See [`docs/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details -- **API Reference**: See [`docs/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints - **Health Dashboard**: Check **Dashboard → Health** for real-time system status - **Translator**: Use **Dashboard → Translator** to debug format issues diff --git a/docs/i18n/gu/docs/UNINSTALL.md b/docs/i18n/gu/docs/guides/UNINSTALL.md similarity index 100% rename from docs/i18n/gu/docs/UNINSTALL.md rename to docs/i18n/gu/docs/guides/UNINSTALL.md diff --git a/docs/i18n/gu/docs/USER_GUIDE.md b/docs/i18n/gu/docs/guides/USER_GUIDE.md similarity index 100% rename from docs/i18n/gu/docs/USER_GUIDE.md rename to docs/i18n/gu/docs/guides/USER_GUIDE.md diff --git a/docs/i18n/gu/docs/COVERAGE_PLAN.md b/docs/i18n/gu/docs/ops/COVERAGE_PLAN.md similarity index 100% rename from docs/i18n/gu/docs/COVERAGE_PLAN.md rename to docs/i18n/gu/docs/ops/COVERAGE_PLAN.md diff --git a/docs/i18n/gu/docs/FLY_IO_DEPLOYMENT_GUIDE.md b/docs/i18n/gu/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/gu/docs/FLY_IO_DEPLOYMENT_GUIDE.md rename to docs/i18n/gu/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/gu/docs/RELEASE_CHECKLIST.md b/docs/i18n/gu/docs/ops/RELEASE_CHECKLIST.md similarity index 94% rename from docs/i18n/gu/docs/RELEASE_CHECKLIST.md rename to docs/i18n/gu/docs/ops/RELEASE_CHECKLIST.md index 9958ba56db..19b13c7330 100644 --- a/docs/i18n/gu/docs/RELEASE_CHECKLIST.md +++ b/docs/i18n/gu/docs/ops/RELEASE_CHECKLIST.md @@ -16,14 +16,14 @@ Use this checklist before tagging or publishing a new OmniRoute release. ## API Docs -1. Update `docs/openapi.yaml`: +1. Update `docs/reference/openapi.yaml`: - `info.version` must equal `package.json` version. 2. Validate endpoint examples if API contracts changed. ## Runtime Docs -1. Review `docs/ARCHITECTURE.md` for storage/runtime drift. -2. Review `docs/TROUBLESHOOTING.md` for env var and operational drift. +1. Review `docs/architecture/ARCHITECTURE.md` for storage/runtime drift. +2. Review `docs/guides/TROUBLESHOOTING.md` for env var and operational drift. 3. Verify the release/runtime Node.js version still satisfies the supported secure floor: - `>=20.20.2 <21` or `>=22.22.2 <23` - `npm run check:node-runtime` diff --git a/docs/i18n/gu/docs/VM_DEPLOYMENT_GUIDE.md b/docs/i18n/gu/docs/ops/VM_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/gu/docs/VM_DEPLOYMENT_GUIDE.md rename to docs/i18n/gu/docs/ops/VM_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/gu/docs/API_REFERENCE.md b/docs/i18n/gu/docs/reference/API_REFERENCE.md similarity index 100% rename from docs/i18n/gu/docs/API_REFERENCE.md rename to docs/i18n/gu/docs/reference/API_REFERENCE.md diff --git a/docs/i18n/gu/docs/CLI-TOOLS.md b/docs/i18n/gu/docs/reference/CLI-TOOLS.md similarity index 100% rename from docs/i18n/gu/docs/CLI-TOOLS.md rename to docs/i18n/gu/docs/reference/CLI-TOOLS.md diff --git a/docs/i18n/gu/docs/ENVIRONMENT.md b/docs/i18n/gu/docs/reference/ENVIRONMENT.md similarity index 100% rename from docs/i18n/gu/docs/ENVIRONMENT.md rename to docs/i18n/gu/docs/reference/ENVIRONMENT.md diff --git a/docs/i18n/gu/docs/AUTO-COMBO.md b/docs/i18n/gu/docs/routing/AUTO-COMBO.md similarity index 100% rename from docs/i18n/gu/docs/AUTO-COMBO.md rename to docs/i18n/gu/docs/routing/AUTO-COMBO.md diff --git a/docs/i18n/gu/llm.txt b/docs/i18n/gu/llm.txt index efdebba7db..b264d4bd77 100644 --- a/docs/i18n/gu/llm.txt +++ b/docs/i18n/gu/llm.txt @@ -357,11 +357,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### MCP Server (37 Tools) | Category | Tools | |------------|-------| -| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/MCP-SERVER.md` for full inventory) | +| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/frameworks/MCP-SERVER.md` for full inventory) | | Memory (3) | `memory_search`, `memory_add`, `memory_clear` | | Skills (4) | `skills_list`, `skills_enable`, `skills_execute`, `skills_executions` | -**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/MCP-SERVER.md`. +**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/frameworks/MCP-SERVER.md`. ### Provider Categories @@ -472,7 +472,7 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo 20. **Guardrails framework** in `src/lib/guardrails/` — hot-reloadable registry. Built-ins (priority-ordered): `vision-bridge` (5) → `pii-masker` (10) → `prompt-injection` (20). Fail-open model: exceptions never block traffic. Per-request opt-out via `x-omniroute-disabled-guardrails` header. -21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/AUTHZ_GUIDE.md`. +21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/architecture/AUTHZ_GUIDE.md`. 22. **Three resilience layers** are distinct (do not conflate them): - **Provider Circuit Breaker** (`src/shared/utils/circuitBreaker.ts`) — whole-provider scope. @@ -489,11 +489,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo - **MCP server expanded to 37 tools** (30 base + 3 memory + 4 skills) across ~13 scopes - **OAuth providers expanded to 14**: added Qwen, Kiro, Qoder, Gemini, Windsurf, GitLab Duo - **Coverage gate raised to 75/75/75/70** (was 60% across the board) — measured ~82% -- **Reasoning replay** (`docs/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams +- **Reasoning replay** (`docs/routing/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams - **Compliance + Evals + Webhooks** documentation introduced -- **Stealth guide** (`docs/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration -- **Tunnels guide** (`docs/TUNNELS_GUIDE.md`) — Cloudflare tunnel management -- **Electron guide** (`docs/ELECTRON_GUIDE.md`) — desktop app build + signing +- **Stealth guide** (`docs/security/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration +- **Tunnels guide** (`docs/ops/TUNNELS_GUIDE.md`) — Cloudflare tunnel management +- **Electron guide** (`docs/guides/ELECTRON_GUIDE.md`) — desktop app build + signing ## Links @@ -505,11 +505,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### Documentation Index -- **Architecture & Reference**: `docs/ARCHITECTURE.md`, `docs/CODEBASE_DOCUMENTATION.md`, `docs/REPOSITORY_MAP.md`, `docs/API_REFERENCE.md`, `docs/PROVIDER_REFERENCE.md`, `docs/openapi.yaml` -- **Operator guides**: `docs/USER_GUIDE.md`, `docs/CLI-TOOLS.md`, `docs/TROUBLESHOOTING.md`, `docs/COVERAGE_PLAN.md` -- **Protocols**: `docs/MCP-SERVER.md`, `docs/A2A-SERVER.md`, `docs/AGENT_PROTOCOLS_GUIDE.md`, `docs/CLOUD_AGENT.md` -- **Routing & resilience**: `docs/AUTO-COMBO.md`, `docs/RESILIENCE_GUIDE.md` -- **Security**: `docs/AUTHZ_GUIDE.md`, `docs/GUARDRAILS.md`, `docs/COMPLIANCE.md`, `docs/STEALTH_GUIDE.md` -- **Extensibility**: `docs/SKILLS.md`, `docs/MEMORY.md`, `docs/EVALS.md`, `docs/WEBHOOKS.md`, `docs/REASONING_REPLAY.md` -- **Platform**: `docs/ELECTRON_GUIDE.md`, `docs/TUNNELS_GUIDE.md` +- **Architecture & Reference**: `docs/architecture/ARCHITECTURE.md`, `docs/architecture/CODEBASE_DOCUMENTATION.md`, `docs/architecture/REPOSITORY_MAP.md`, `docs/reference/API_REFERENCE.md`, `docs/reference/PROVIDER_REFERENCE.md`, `docs/reference/openapi.yaml` +- **Operator guides**: `docs/guides/USER_GUIDE.md`, `docs/reference/CLI-TOOLS.md`, `docs/guides/TROUBLESHOOTING.md`, `docs/ops/COVERAGE_PLAN.md` +- **Protocols**: `docs/frameworks/MCP-SERVER.md`, `docs/frameworks/A2A-SERVER.md`, `docs/frameworks/AGENT_PROTOCOLS_GUIDE.md`, `docs/frameworks/CLOUD_AGENT.md` +- **Routing & resilience**: `docs/routing/AUTO-COMBO.md`, `docs/architecture/RESILIENCE_GUIDE.md` +- **Security**: `docs/architecture/AUTHZ_GUIDE.md`, `docs/security/GUARDRAILS.md`, `docs/security/COMPLIANCE.md`, `docs/security/STEALTH_GUIDE.md` +- **Extensibility**: `docs/frameworks/SKILLS.md`, `docs/frameworks/MEMORY.md`, `docs/frameworks/EVALS.md`, `docs/frameworks/WEBHOOKS.md`, `docs/routing/REASONING_REPLAY.md` +- **Platform**: `docs/guides/ELECTRON_GUIDE.md`, `docs/ops/TUNNELS_GUIDE.md` - **AI agents**: `CLAUDE.md`, `AGENTS.md`, `GEMINI.md` diff --git a/docs/i18n/he/CHANGELOG.md b/docs/i18n/he/CHANGELOG.md index 86de7f2cd1..4a3b9155ba 100644 --- a/docs/i18n/he/CHANGELOG.md +++ b/docs/i18n/he/CHANGELOG.md @@ -1310,7 +1310,7 @@ We identified that **155 community PRs** across the entire project history (from - **33 New API Key Providers:** Massive provider expansion adding DeepInfra, Vercel AI Gateway, Lambda AI, SambaNova, nScale, OVHcloud AI, Baseten, PublicAI, Moonshot AI, Meta Llama API, v0 (Vercel), Morph, Featherless AI, FriendliAI, LlamaGate, Galadriel, Weights & Biases Inference, Volcengine, AI21 Labs, Venice.ai, Codestral, Upstage, Maritalk, Xiaomi MiMo, Inference.net, NanoGPT, Predibase, Bytez, Heroku AI, Databricks, Snowflake Cortex, and GigaChat (Sber). OmniRoute now supports **100+ providers** (4 Free + 8 OAuth + 91 API Key + Custom compatible) - **Global Email Privacy Toggle:** Added a persistent eye-icon toggle button across all dashboard pages (Providers, Usage Limits, Playground) that reveals or hides masked email addresses. Toggle state is stored in localStorage and synced globally via Zustand store - **Documentation Refresh:** Updated README, ARCHITECTURE, FEATURES, AGENTS.md, and API_REFERENCE for v3.6.2 with accurate provider counts (100+), new executor list, and system API documentation -- **Uninstall Guide:** Created comprehensive `docs/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) +- **Uninstall Guide:** Created comprehensive `docs/guides/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) ### 🐛 Bug Fixes diff --git a/docs/i18n/he/CONTRIBUTING.md b/docs/i18n/he/CONTRIBUTING.md index 41057457dd..9601204b67 100644 --- a/docs/i18n/he/CONTRIBUTING.md +++ b/docs/i18n/he/CONTRIBUTING.md @@ -153,7 +153,7 @@ Coverage notes: - If a PR changes production code in `src/`, `open-sse/`, `electron/`, or `bin/`, it must add or update automated tests in the same PR - `npm run coverage:report` prints the detailed file-by-file report from the latest coverage run - `npm run test:coverage:legacy` preserves the older metric for historical comparison -- See `docs/COVERAGE_PLAN.md` for the phased coverage improvement roadmap +- See `docs/ops/COVERAGE_PLAN.md` for the phased coverage improvement roadmap ### Pull Request Requirements @@ -305,7 +305,7 @@ Releases are managed via the `/generate-release` workflow. When a new GitHub Rel ## Getting Help -- **Architecture**: See [`docs/ARCHITECTURE.md`](docs/ARCHITECTURE.md) -- **API Reference**: See [`docs/API_REFERENCE.md`](docs/API_REFERENCE.md) +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](docs/architecture/ARCHITECTURE.md) +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](docs/reference/API_REFERENCE.md) - **Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) - **ADRs**: See `docs/adr/` for architectural decision records diff --git a/docs/i18n/he/README.md b/docs/i18n/he/README.md index a3f9901683..a3284424a3 100644 --- a/docs/i18n/he/README.md +++ b/docs/i18n/he/README.md @@ -2267,25 +2267,25 @@ Se não quiser criar credenciais próprias agora, ainda é possível usar o flux ## תיעוד -| Document | Description | -| -------------------------------------------------------- | --------------------------------------------------- | -| [User Guide](docs/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | -| [API Reference](docs/API_REFERENCE.md) | All endpoints with examples | -| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | -| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | -| [Auto-Combo Engine](docs/AUTO-COMBO.md) | 6-factor scoring, mode packs, self-healing | -| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | -| [Troubleshooting](docs/TROUBLESHOOTING.md) | Common problems and solutions | -| [Architecture](docs/ARCHITECTURE.md) | System architecture and internals | -| [Codebase Documentation](docs/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | -| [Uninstall Guide](docs/UNINSTALL.md) | Clean removal for all install methods | -| [Environment Config](docs/ENVIRONMENT.md) | Complete `.env` variables and references | -| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | -| [OpenAPI Spec](docs/openapi.yaml) | OpenAPI 3.0 specification | -| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | -| [VM Deployment](docs/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | -| [Features Gallery](docs/FEATURES.md) | Visual dashboard tour with screenshots | -| [Release Checklist](docs/RELEASE_CHECKLIST.md) | Pre-release validation steps | +| Document | Description | +| --------------------------------------------------------------------- | --------------------------------------------------- | +| [User Guide](docs/guides/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | +| [API Reference](docs/reference/API_REFERENCE.md) | All endpoints with examples | +| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | +| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | +| [Auto-Combo Engine](docs/routing/AUTO-COMBO.md) | 6-factor scoring, mode packs, self-healing | +| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | +| [Troubleshooting](docs/guides/TROUBLESHOOTING.md) | Common problems and solutions | +| [Architecture](docs/architecture/ARCHITECTURE.md) | System architecture and internals | +| [Codebase Documentation](docs/architecture/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | +| [Uninstall Guide](docs/guides/UNINSTALL.md) | Clean removal for all install methods | +| [Environment Config](docs/reference/ENVIRONMENT.md) | Complete `.env` variables and references | +| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | +| [OpenAPI Spec](docs/reference/openapi.yaml) | OpenAPI 3.0 specification | +| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | +| [VM Deployment](docs/ops/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | +| [Features Gallery](docs/guides/FEATURES.md) | Visual dashboard tour with screenshots | +| [Release Checklist](docs/ops/RELEASE_CHECKLIST.md) | Pre-release validation steps | --- diff --git a/docs/i18n/he/docs/ARCHITECTURE.md b/docs/i18n/he/docs/architecture/ARCHITECTURE.md similarity index 100% rename from docs/i18n/he/docs/ARCHITECTURE.md rename to docs/i18n/he/docs/architecture/ARCHITECTURE.md diff --git a/docs/i18n/he/docs/CODEBASE_DOCUMENTATION.md b/docs/i18n/he/docs/architecture/CODEBASE_DOCUMENTATION.md similarity index 100% rename from docs/i18n/he/docs/CODEBASE_DOCUMENTATION.md rename to docs/i18n/he/docs/architecture/CODEBASE_DOCUMENTATION.md diff --git a/docs/i18n/he/docs/A2A-SERVER.md b/docs/i18n/he/docs/frameworks/A2A-SERVER.md similarity index 100% rename from docs/i18n/he/docs/A2A-SERVER.md rename to docs/i18n/he/docs/frameworks/A2A-SERVER.md diff --git a/docs/i18n/he/docs/MCP-SERVER.md b/docs/i18n/he/docs/frameworks/MCP-SERVER.md similarity index 100% rename from docs/i18n/he/docs/MCP-SERVER.md rename to docs/i18n/he/docs/frameworks/MCP-SERVER.md diff --git a/docs/i18n/he/docs/FEATURES.md b/docs/i18n/he/docs/guides/FEATURES.md similarity index 100% rename from docs/i18n/he/docs/FEATURES.md rename to docs/i18n/he/docs/guides/FEATURES.md diff --git a/docs/i18n/he/docs/I18N.md b/docs/i18n/he/docs/guides/I18N.md similarity index 99% rename from docs/i18n/he/docs/I18N.md rename to docs/i18n/he/docs/guides/I18N.md index 1c2907f68d..02db6a375e 100644 --- a/docs/i18n/he/docs/I18N.md +++ b/docs/i18n/he/docs/guides/I18N.md @@ -420,7 +420,7 @@ The generator originally used `code: "in"` (deprecated Google Translate code) fo ### `docs/i18n/README.md` Is Auto-Generated -The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/I18N.md` (this file) for hand-written documentation that should persist. +The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/guides/I18N.md` (this file) for hand-written documentation that should persist. ### External Untranslatable Keys List diff --git a/docs/i18n/he/docs/TROUBLESHOOTING.md b/docs/i18n/he/docs/guides/TROUBLESHOOTING.md similarity index 98% rename from docs/i18n/he/docs/TROUBLESHOOTING.md rename to docs/i18n/he/docs/guides/TROUBLESHOOTING.md index 19c167b042..083e96091b 100644 --- a/docs/i18n/he/docs/TROUBLESHOOTING.md +++ b/docs/i18n/he/docs/guides/TROUBLESHOOTING.md @@ -335,7 +335,7 @@ You can ignore this section if you do not run RAG or agent pipelines behind Omni ## Still Stuck? - **GitHub Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) -- **Architecture**: See [`docs/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details -- **API Reference**: See [`docs/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints - **Health Dashboard**: Check **Dashboard → Health** for real-time system status - **Translator**: Use **Dashboard → Translator** to debug format issues diff --git a/docs/i18n/he/docs/UNINSTALL.md b/docs/i18n/he/docs/guides/UNINSTALL.md similarity index 100% rename from docs/i18n/he/docs/UNINSTALL.md rename to docs/i18n/he/docs/guides/UNINSTALL.md diff --git a/docs/i18n/he/docs/USER_GUIDE.md b/docs/i18n/he/docs/guides/USER_GUIDE.md similarity index 100% rename from docs/i18n/he/docs/USER_GUIDE.md rename to docs/i18n/he/docs/guides/USER_GUIDE.md diff --git a/docs/i18n/he/docs/COVERAGE_PLAN.md b/docs/i18n/he/docs/ops/COVERAGE_PLAN.md similarity index 100% rename from docs/i18n/he/docs/COVERAGE_PLAN.md rename to docs/i18n/he/docs/ops/COVERAGE_PLAN.md diff --git a/docs/i18n/he/docs/FLY_IO_DEPLOYMENT_GUIDE.md b/docs/i18n/he/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/he/docs/FLY_IO_DEPLOYMENT_GUIDE.md rename to docs/i18n/he/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/he/docs/RELEASE_CHECKLIST.md b/docs/i18n/he/docs/ops/RELEASE_CHECKLIST.md similarity index 94% rename from docs/i18n/he/docs/RELEASE_CHECKLIST.md rename to docs/i18n/he/docs/ops/RELEASE_CHECKLIST.md index 5962d37525..e9c052da06 100644 --- a/docs/i18n/he/docs/RELEASE_CHECKLIST.md +++ b/docs/i18n/he/docs/ops/RELEASE_CHECKLIST.md @@ -16,14 +16,14 @@ Use this checklist before tagging or publishing a new OmniRoute release. ## API Docs -1. Update `docs/openapi.yaml`: +1. Update `docs/reference/openapi.yaml`: - `info.version` must equal `package.json` version. 2. Validate endpoint examples if API contracts changed. ## Runtime Docs -1. Review `docs/ARCHITECTURE.md` for storage/runtime drift. -2. Review `docs/TROUBLESHOOTING.md` for env var and operational drift. +1. Review `docs/architecture/ARCHITECTURE.md` for storage/runtime drift. +2. Review `docs/guides/TROUBLESHOOTING.md` for env var and operational drift. 3. Verify the release/runtime Node.js version still satisfies the supported secure floor: - `>=20.20.2 <21` or `>=22.22.2 <23` - `npm run check:node-runtime` diff --git a/docs/i18n/he/docs/VM_DEPLOYMENT_GUIDE.md b/docs/i18n/he/docs/ops/VM_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/he/docs/VM_DEPLOYMENT_GUIDE.md rename to docs/i18n/he/docs/ops/VM_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/he/docs/API_REFERENCE.md b/docs/i18n/he/docs/reference/API_REFERENCE.md similarity index 100% rename from docs/i18n/he/docs/API_REFERENCE.md rename to docs/i18n/he/docs/reference/API_REFERENCE.md diff --git a/docs/i18n/he/docs/CLI-TOOLS.md b/docs/i18n/he/docs/reference/CLI-TOOLS.md similarity index 100% rename from docs/i18n/he/docs/CLI-TOOLS.md rename to docs/i18n/he/docs/reference/CLI-TOOLS.md diff --git a/docs/i18n/he/docs/ENVIRONMENT.md b/docs/i18n/he/docs/reference/ENVIRONMENT.md similarity index 100% rename from docs/i18n/he/docs/ENVIRONMENT.md rename to docs/i18n/he/docs/reference/ENVIRONMENT.md diff --git a/docs/i18n/he/docs/AUTO-COMBO.md b/docs/i18n/he/docs/routing/AUTO-COMBO.md similarity index 100% rename from docs/i18n/he/docs/AUTO-COMBO.md rename to docs/i18n/he/docs/routing/AUTO-COMBO.md diff --git a/docs/i18n/he/llm.txt b/docs/i18n/he/llm.txt index ea3add4736..96aa52741c 100644 --- a/docs/i18n/he/llm.txt +++ b/docs/i18n/he/llm.txt @@ -357,11 +357,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### MCP Server (37 Tools) | Category | Tools | |------------|-------| -| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/MCP-SERVER.md` for full inventory) | +| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/frameworks/MCP-SERVER.md` for full inventory) | | Memory (3) | `memory_search`, `memory_add`, `memory_clear` | | Skills (4) | `skills_list`, `skills_enable`, `skills_execute`, `skills_executions` | -**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/MCP-SERVER.md`. +**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/frameworks/MCP-SERVER.md`. ### Provider Categories @@ -472,7 +472,7 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo 20. **Guardrails framework** in `src/lib/guardrails/` — hot-reloadable registry. Built-ins (priority-ordered): `vision-bridge` (5) → `pii-masker` (10) → `prompt-injection` (20). Fail-open model: exceptions never block traffic. Per-request opt-out via `x-omniroute-disabled-guardrails` header. -21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/AUTHZ_GUIDE.md`. +21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/architecture/AUTHZ_GUIDE.md`. 22. **Three resilience layers** are distinct (do not conflate them): - **Provider Circuit Breaker** (`src/shared/utils/circuitBreaker.ts`) — whole-provider scope. @@ -489,11 +489,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo - **MCP server expanded to 37 tools** (30 base + 3 memory + 4 skills) across ~13 scopes - **OAuth providers expanded to 14**: added Qwen, Kiro, Qoder, Gemini, Windsurf, GitLab Duo - **Coverage gate raised to 75/75/75/70** (was 60% across the board) — measured ~82% -- **Reasoning replay** (`docs/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams +- **Reasoning replay** (`docs/routing/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams - **Compliance + Evals + Webhooks** documentation introduced -- **Stealth guide** (`docs/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration -- **Tunnels guide** (`docs/TUNNELS_GUIDE.md`) — Cloudflare tunnel management -- **Electron guide** (`docs/ELECTRON_GUIDE.md`) — desktop app build + signing +- **Stealth guide** (`docs/security/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration +- **Tunnels guide** (`docs/ops/TUNNELS_GUIDE.md`) — Cloudflare tunnel management +- **Electron guide** (`docs/guides/ELECTRON_GUIDE.md`) — desktop app build + signing ## Links @@ -505,11 +505,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### Documentation Index -- **Architecture & Reference**: `docs/ARCHITECTURE.md`, `docs/CODEBASE_DOCUMENTATION.md`, `docs/REPOSITORY_MAP.md`, `docs/API_REFERENCE.md`, `docs/PROVIDER_REFERENCE.md`, `docs/openapi.yaml` -- **Operator guides**: `docs/USER_GUIDE.md`, `docs/CLI-TOOLS.md`, `docs/TROUBLESHOOTING.md`, `docs/COVERAGE_PLAN.md` -- **Protocols**: `docs/MCP-SERVER.md`, `docs/A2A-SERVER.md`, `docs/AGENT_PROTOCOLS_GUIDE.md`, `docs/CLOUD_AGENT.md` -- **Routing & resilience**: `docs/AUTO-COMBO.md`, `docs/RESILIENCE_GUIDE.md` -- **Security**: `docs/AUTHZ_GUIDE.md`, `docs/GUARDRAILS.md`, `docs/COMPLIANCE.md`, `docs/STEALTH_GUIDE.md` -- **Extensibility**: `docs/SKILLS.md`, `docs/MEMORY.md`, `docs/EVALS.md`, `docs/WEBHOOKS.md`, `docs/REASONING_REPLAY.md` -- **Platform**: `docs/ELECTRON_GUIDE.md`, `docs/TUNNELS_GUIDE.md` +- **Architecture & Reference**: `docs/architecture/ARCHITECTURE.md`, `docs/architecture/CODEBASE_DOCUMENTATION.md`, `docs/architecture/REPOSITORY_MAP.md`, `docs/reference/API_REFERENCE.md`, `docs/reference/PROVIDER_REFERENCE.md`, `docs/reference/openapi.yaml` +- **Operator guides**: `docs/guides/USER_GUIDE.md`, `docs/reference/CLI-TOOLS.md`, `docs/guides/TROUBLESHOOTING.md`, `docs/ops/COVERAGE_PLAN.md` +- **Protocols**: `docs/frameworks/MCP-SERVER.md`, `docs/frameworks/A2A-SERVER.md`, `docs/frameworks/AGENT_PROTOCOLS_GUIDE.md`, `docs/frameworks/CLOUD_AGENT.md` +- **Routing & resilience**: `docs/routing/AUTO-COMBO.md`, `docs/architecture/RESILIENCE_GUIDE.md` +- **Security**: `docs/architecture/AUTHZ_GUIDE.md`, `docs/security/GUARDRAILS.md`, `docs/security/COMPLIANCE.md`, `docs/security/STEALTH_GUIDE.md` +- **Extensibility**: `docs/frameworks/SKILLS.md`, `docs/frameworks/MEMORY.md`, `docs/frameworks/EVALS.md`, `docs/frameworks/WEBHOOKS.md`, `docs/routing/REASONING_REPLAY.md` +- **Platform**: `docs/guides/ELECTRON_GUIDE.md`, `docs/ops/TUNNELS_GUIDE.md` - **AI agents**: `CLAUDE.md`, `AGENTS.md`, `GEMINI.md` diff --git a/docs/i18n/hi/CHANGELOG.md b/docs/i18n/hi/CHANGELOG.md index bbbbfd6766..9062bf5e09 100644 --- a/docs/i18n/hi/CHANGELOG.md +++ b/docs/i18n/hi/CHANGELOG.md @@ -1310,7 +1310,7 @@ We identified that **155 community PRs** across the entire project history (from - **33 New API Key Providers:** Massive provider expansion adding DeepInfra, Vercel AI Gateway, Lambda AI, SambaNova, nScale, OVHcloud AI, Baseten, PublicAI, Moonshot AI, Meta Llama API, v0 (Vercel), Morph, Featherless AI, FriendliAI, LlamaGate, Galadriel, Weights & Biases Inference, Volcengine, AI21 Labs, Venice.ai, Codestral, Upstage, Maritalk, Xiaomi MiMo, Inference.net, NanoGPT, Predibase, Bytez, Heroku AI, Databricks, Snowflake Cortex, and GigaChat (Sber). OmniRoute now supports **100+ providers** (4 Free + 8 OAuth + 91 API Key + Custom compatible) - **Global Email Privacy Toggle:** Added a persistent eye-icon toggle button across all dashboard pages (Providers, Usage Limits, Playground) that reveals or hides masked email addresses. Toggle state is stored in localStorage and synced globally via Zustand store - **Documentation Refresh:** Updated README, ARCHITECTURE, FEATURES, AGENTS.md, and API_REFERENCE for v3.6.2 with accurate provider counts (100+), new executor list, and system API documentation -- **Uninstall Guide:** Created comprehensive `docs/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) +- **Uninstall Guide:** Created comprehensive `docs/guides/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) ### 🐛 Bug Fixes diff --git a/docs/i18n/hi/CONTRIBUTING.md b/docs/i18n/hi/CONTRIBUTING.md index 2a03264ea0..a2b59099b8 100644 --- a/docs/i18n/hi/CONTRIBUTING.md +++ b/docs/i18n/hi/CONTRIBUTING.md @@ -153,7 +153,7 @@ Coverage notes: - If a PR changes production code in `src/`, `open-sse/`, `electron/`, or `bin/`, it must add or update automated tests in the same PR - `npm run coverage:report` prints the detailed file-by-file report from the latest coverage run - `npm run test:coverage:legacy` preserves the older metric for historical comparison -- See `docs/COVERAGE_PLAN.md` for the phased coverage improvement roadmap +- See `docs/ops/COVERAGE_PLAN.md` for the phased coverage improvement roadmap ### Pull Request Requirements @@ -305,7 +305,7 @@ Releases are managed via the `/generate-release` workflow. When a new GitHub Rel ## Getting Help -- **Architecture**: See [`docs/ARCHITECTURE.md`](docs/ARCHITECTURE.md) -- **API Reference**: See [`docs/API_REFERENCE.md`](docs/API_REFERENCE.md) +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](docs/architecture/ARCHITECTURE.md) +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](docs/reference/API_REFERENCE.md) - **Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) - **ADRs**: See `docs/adr/` for architectural decision records diff --git a/docs/i18n/hi/README.md b/docs/i18n/hi/README.md index be8b2e4647..e9150cc01a 100644 --- a/docs/i18n/hi/README.md +++ b/docs/i18n/hi/README.md @@ -2267,25 +2267,25 @@ Se não quiser criar credenciais próprias agora, ainda é possível usar o flux ## दस्तावेज़ -| Document | Description | -| -------------------------------------------------------- | --------------------------------------------------- | -| [User Guide](docs/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | -| [API Reference](docs/API_REFERENCE.md) | All endpoints with examples | -| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | -| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | -| [Auto-Combo Engine](docs/AUTO-COMBO.md) | 6-factor scoring, mode packs, self-healing | -| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | -| [Troubleshooting](docs/TROUBLESHOOTING.md) | Common problems and solutions | -| [Architecture](docs/ARCHITECTURE.md) | System architecture and internals | -| [Codebase Documentation](docs/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | -| [Uninstall Guide](docs/UNINSTALL.md) | Clean removal for all install methods | -| [Environment Config](docs/ENVIRONMENT.md) | Complete `.env` variables and references | -| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | -| [OpenAPI Spec](docs/openapi.yaml) | OpenAPI 3.0 specification | -| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | -| [VM Deployment](docs/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | -| [Features Gallery](docs/FEATURES.md) | Visual dashboard tour with screenshots | -| [Release Checklist](docs/RELEASE_CHECKLIST.md) | Pre-release validation steps | +| Document | Description | +| --------------------------------------------------------------------- | --------------------------------------------------- | +| [User Guide](docs/guides/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | +| [API Reference](docs/reference/API_REFERENCE.md) | All endpoints with examples | +| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | +| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | +| [Auto-Combo Engine](docs/routing/AUTO-COMBO.md) | 6-factor scoring, mode packs, self-healing | +| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | +| [Troubleshooting](docs/guides/TROUBLESHOOTING.md) | Common problems and solutions | +| [Architecture](docs/architecture/ARCHITECTURE.md) | System architecture and internals | +| [Codebase Documentation](docs/architecture/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | +| [Uninstall Guide](docs/guides/UNINSTALL.md) | Clean removal for all install methods | +| [Environment Config](docs/reference/ENVIRONMENT.md) | Complete `.env` variables and references | +| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | +| [OpenAPI Spec](docs/reference/openapi.yaml) | OpenAPI 3.0 specification | +| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | +| [VM Deployment](docs/ops/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | +| [Features Gallery](docs/guides/FEATURES.md) | Visual dashboard tour with screenshots | +| [Release Checklist](docs/ops/RELEASE_CHECKLIST.md) | Pre-release validation steps | --- diff --git a/docs/i18n/hi/docs/ARCHITECTURE.md b/docs/i18n/hi/docs/architecture/ARCHITECTURE.md similarity index 100% rename from docs/i18n/hi/docs/ARCHITECTURE.md rename to docs/i18n/hi/docs/architecture/ARCHITECTURE.md diff --git a/docs/i18n/hi/docs/CODEBASE_DOCUMENTATION.md b/docs/i18n/hi/docs/architecture/CODEBASE_DOCUMENTATION.md similarity index 100% rename from docs/i18n/hi/docs/CODEBASE_DOCUMENTATION.md rename to docs/i18n/hi/docs/architecture/CODEBASE_DOCUMENTATION.md diff --git a/docs/i18n/hi/docs/A2A-SERVER.md b/docs/i18n/hi/docs/frameworks/A2A-SERVER.md similarity index 100% rename from docs/i18n/hi/docs/A2A-SERVER.md rename to docs/i18n/hi/docs/frameworks/A2A-SERVER.md diff --git a/docs/i18n/hi/docs/MCP-SERVER.md b/docs/i18n/hi/docs/frameworks/MCP-SERVER.md similarity index 100% rename from docs/i18n/hi/docs/MCP-SERVER.md rename to docs/i18n/hi/docs/frameworks/MCP-SERVER.md diff --git a/docs/i18n/hi/docs/FEATURES.md b/docs/i18n/hi/docs/guides/FEATURES.md similarity index 100% rename from docs/i18n/hi/docs/FEATURES.md rename to docs/i18n/hi/docs/guides/FEATURES.md diff --git a/docs/i18n/hi/docs/I18N.md b/docs/i18n/hi/docs/guides/I18N.md similarity index 99% rename from docs/i18n/hi/docs/I18N.md rename to docs/i18n/hi/docs/guides/I18N.md index 4b35d190b0..99819dea66 100644 --- a/docs/i18n/hi/docs/I18N.md +++ b/docs/i18n/hi/docs/guides/I18N.md @@ -420,7 +420,7 @@ The generator originally used `code: "in"` (deprecated Google Translate code) fo ### `docs/i18n/README.md` Is Auto-Generated -The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/I18N.md` (this file) for hand-written documentation that should persist. +The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/guides/I18N.md` (this file) for hand-written documentation that should persist. ### External Untranslatable Keys List diff --git a/docs/i18n/hi/docs/TROUBLESHOOTING.md b/docs/i18n/hi/docs/guides/TROUBLESHOOTING.md similarity index 98% rename from docs/i18n/hi/docs/TROUBLESHOOTING.md rename to docs/i18n/hi/docs/guides/TROUBLESHOOTING.md index 9b2aa8e809..b0a1a63de1 100644 --- a/docs/i18n/hi/docs/TROUBLESHOOTING.md +++ b/docs/i18n/hi/docs/guides/TROUBLESHOOTING.md @@ -335,7 +335,7 @@ You can ignore this section if you do not run RAG or agent pipelines behind Omni ## Still Stuck? - **GitHub Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) -- **Architecture**: See [`docs/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details -- **API Reference**: See [`docs/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints - **Health Dashboard**: Check **Dashboard → Health** for real-time system status - **Translator**: Use **Dashboard → Translator** to debug format issues diff --git a/docs/i18n/hi/docs/UNINSTALL.md b/docs/i18n/hi/docs/guides/UNINSTALL.md similarity index 100% rename from docs/i18n/hi/docs/UNINSTALL.md rename to docs/i18n/hi/docs/guides/UNINSTALL.md diff --git a/docs/i18n/hi/docs/USER_GUIDE.md b/docs/i18n/hi/docs/guides/USER_GUIDE.md similarity index 100% rename from docs/i18n/hi/docs/USER_GUIDE.md rename to docs/i18n/hi/docs/guides/USER_GUIDE.md diff --git a/docs/i18n/hi/docs/COVERAGE_PLAN.md b/docs/i18n/hi/docs/ops/COVERAGE_PLAN.md similarity index 100% rename from docs/i18n/hi/docs/COVERAGE_PLAN.md rename to docs/i18n/hi/docs/ops/COVERAGE_PLAN.md diff --git a/docs/i18n/hi/docs/FLY_IO_DEPLOYMENT_GUIDE.md b/docs/i18n/hi/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/hi/docs/FLY_IO_DEPLOYMENT_GUIDE.md rename to docs/i18n/hi/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/hi/docs/RELEASE_CHECKLIST.md b/docs/i18n/hi/docs/ops/RELEASE_CHECKLIST.md similarity index 94% rename from docs/i18n/hi/docs/RELEASE_CHECKLIST.md rename to docs/i18n/hi/docs/ops/RELEASE_CHECKLIST.md index f406a0d7ad..7a114ea0b9 100644 --- a/docs/i18n/hi/docs/RELEASE_CHECKLIST.md +++ b/docs/i18n/hi/docs/ops/RELEASE_CHECKLIST.md @@ -16,14 +16,14 @@ Use this checklist before tagging or publishing a new OmniRoute release. ## API Docs -1. Update `docs/openapi.yaml`: +1. Update `docs/reference/openapi.yaml`: - `info.version` must equal `package.json` version. 2. Validate endpoint examples if API contracts changed. ## Runtime Docs -1. Review `docs/ARCHITECTURE.md` for storage/runtime drift. -2. Review `docs/TROUBLESHOOTING.md` for env var and operational drift. +1. Review `docs/architecture/ARCHITECTURE.md` for storage/runtime drift. +2. Review `docs/guides/TROUBLESHOOTING.md` for env var and operational drift. 3. Verify the release/runtime Node.js version still satisfies the supported secure floor: - `>=20.20.2 <21` or `>=22.22.2 <23` - `npm run check:node-runtime` diff --git a/docs/i18n/hi/docs/VM_DEPLOYMENT_GUIDE.md b/docs/i18n/hi/docs/ops/VM_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/hi/docs/VM_DEPLOYMENT_GUIDE.md rename to docs/i18n/hi/docs/ops/VM_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/hi/docs/API_REFERENCE.md b/docs/i18n/hi/docs/reference/API_REFERENCE.md similarity index 100% rename from docs/i18n/hi/docs/API_REFERENCE.md rename to docs/i18n/hi/docs/reference/API_REFERENCE.md diff --git a/docs/i18n/hi/docs/CLI-TOOLS.md b/docs/i18n/hi/docs/reference/CLI-TOOLS.md similarity index 100% rename from docs/i18n/hi/docs/CLI-TOOLS.md rename to docs/i18n/hi/docs/reference/CLI-TOOLS.md diff --git a/docs/i18n/hi/docs/ENVIRONMENT.md b/docs/i18n/hi/docs/reference/ENVIRONMENT.md similarity index 100% rename from docs/i18n/hi/docs/ENVIRONMENT.md rename to docs/i18n/hi/docs/reference/ENVIRONMENT.md diff --git a/docs/i18n/hi/docs/AUTO-COMBO.md b/docs/i18n/hi/docs/routing/AUTO-COMBO.md similarity index 100% rename from docs/i18n/hi/docs/AUTO-COMBO.md rename to docs/i18n/hi/docs/routing/AUTO-COMBO.md diff --git a/docs/i18n/hi/llm.txt b/docs/i18n/hi/llm.txt index 4c1fd0e7b5..940e48983e 100644 --- a/docs/i18n/hi/llm.txt +++ b/docs/i18n/hi/llm.txt @@ -357,11 +357,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### MCP Server (37 Tools) | Category | Tools | |------------|-------| -| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/MCP-SERVER.md` for full inventory) | +| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/frameworks/MCP-SERVER.md` for full inventory) | | Memory (3) | `memory_search`, `memory_add`, `memory_clear` | | Skills (4) | `skills_list`, `skills_enable`, `skills_execute`, `skills_executions` | -**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/MCP-SERVER.md`. +**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/frameworks/MCP-SERVER.md`. ### Provider Categories @@ -472,7 +472,7 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo 20. **Guardrails framework** in `src/lib/guardrails/` — hot-reloadable registry. Built-ins (priority-ordered): `vision-bridge` (5) → `pii-masker` (10) → `prompt-injection` (20). Fail-open model: exceptions never block traffic. Per-request opt-out via `x-omniroute-disabled-guardrails` header. -21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/AUTHZ_GUIDE.md`. +21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/architecture/AUTHZ_GUIDE.md`. 22. **Three resilience layers** are distinct (do not conflate them): - **Provider Circuit Breaker** (`src/shared/utils/circuitBreaker.ts`) — whole-provider scope. @@ -489,11 +489,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo - **MCP server expanded to 37 tools** (30 base + 3 memory + 4 skills) across ~13 scopes - **OAuth providers expanded to 14**: added Qwen, Kiro, Qoder, Gemini, Windsurf, GitLab Duo - **Coverage gate raised to 75/75/75/70** (was 60% across the board) — measured ~82% -- **Reasoning replay** (`docs/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams +- **Reasoning replay** (`docs/routing/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams - **Compliance + Evals + Webhooks** documentation introduced -- **Stealth guide** (`docs/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration -- **Tunnels guide** (`docs/TUNNELS_GUIDE.md`) — Cloudflare tunnel management -- **Electron guide** (`docs/ELECTRON_GUIDE.md`) — desktop app build + signing +- **Stealth guide** (`docs/security/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration +- **Tunnels guide** (`docs/ops/TUNNELS_GUIDE.md`) — Cloudflare tunnel management +- **Electron guide** (`docs/guides/ELECTRON_GUIDE.md`) — desktop app build + signing ## Links @@ -505,11 +505,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### Documentation Index -- **Architecture & Reference**: `docs/ARCHITECTURE.md`, `docs/CODEBASE_DOCUMENTATION.md`, `docs/REPOSITORY_MAP.md`, `docs/API_REFERENCE.md`, `docs/PROVIDER_REFERENCE.md`, `docs/openapi.yaml` -- **Operator guides**: `docs/USER_GUIDE.md`, `docs/CLI-TOOLS.md`, `docs/TROUBLESHOOTING.md`, `docs/COVERAGE_PLAN.md` -- **Protocols**: `docs/MCP-SERVER.md`, `docs/A2A-SERVER.md`, `docs/AGENT_PROTOCOLS_GUIDE.md`, `docs/CLOUD_AGENT.md` -- **Routing & resilience**: `docs/AUTO-COMBO.md`, `docs/RESILIENCE_GUIDE.md` -- **Security**: `docs/AUTHZ_GUIDE.md`, `docs/GUARDRAILS.md`, `docs/COMPLIANCE.md`, `docs/STEALTH_GUIDE.md` -- **Extensibility**: `docs/SKILLS.md`, `docs/MEMORY.md`, `docs/EVALS.md`, `docs/WEBHOOKS.md`, `docs/REASONING_REPLAY.md` -- **Platform**: `docs/ELECTRON_GUIDE.md`, `docs/TUNNELS_GUIDE.md` +- **Architecture & Reference**: `docs/architecture/ARCHITECTURE.md`, `docs/architecture/CODEBASE_DOCUMENTATION.md`, `docs/architecture/REPOSITORY_MAP.md`, `docs/reference/API_REFERENCE.md`, `docs/reference/PROVIDER_REFERENCE.md`, `docs/reference/openapi.yaml` +- **Operator guides**: `docs/guides/USER_GUIDE.md`, `docs/reference/CLI-TOOLS.md`, `docs/guides/TROUBLESHOOTING.md`, `docs/ops/COVERAGE_PLAN.md` +- **Protocols**: `docs/frameworks/MCP-SERVER.md`, `docs/frameworks/A2A-SERVER.md`, `docs/frameworks/AGENT_PROTOCOLS_GUIDE.md`, `docs/frameworks/CLOUD_AGENT.md` +- **Routing & resilience**: `docs/routing/AUTO-COMBO.md`, `docs/architecture/RESILIENCE_GUIDE.md` +- **Security**: `docs/architecture/AUTHZ_GUIDE.md`, `docs/security/GUARDRAILS.md`, `docs/security/COMPLIANCE.md`, `docs/security/STEALTH_GUIDE.md` +- **Extensibility**: `docs/frameworks/SKILLS.md`, `docs/frameworks/MEMORY.md`, `docs/frameworks/EVALS.md`, `docs/frameworks/WEBHOOKS.md`, `docs/routing/REASONING_REPLAY.md` +- **Platform**: `docs/guides/ELECTRON_GUIDE.md`, `docs/ops/TUNNELS_GUIDE.md` - **AI agents**: `CLAUDE.md`, `AGENTS.md`, `GEMINI.md` diff --git a/docs/i18n/hu/CHANGELOG.md b/docs/i18n/hu/CHANGELOG.md index a00a13ec91..aaaa8aad8a 100644 --- a/docs/i18n/hu/CHANGELOG.md +++ b/docs/i18n/hu/CHANGELOG.md @@ -1310,7 +1310,7 @@ We identified that **155 community PRs** across the entire project history (from - **33 New API Key Providers:** Massive provider expansion adding DeepInfra, Vercel AI Gateway, Lambda AI, SambaNova, nScale, OVHcloud AI, Baseten, PublicAI, Moonshot AI, Meta Llama API, v0 (Vercel), Morph, Featherless AI, FriendliAI, LlamaGate, Galadriel, Weights & Biases Inference, Volcengine, AI21 Labs, Venice.ai, Codestral, Upstage, Maritalk, Xiaomi MiMo, Inference.net, NanoGPT, Predibase, Bytez, Heroku AI, Databricks, Snowflake Cortex, and GigaChat (Sber). OmniRoute now supports **100+ providers** (4 Free + 8 OAuth + 91 API Key + Custom compatible) - **Global Email Privacy Toggle:** Added a persistent eye-icon toggle button across all dashboard pages (Providers, Usage Limits, Playground) that reveals or hides masked email addresses. Toggle state is stored in localStorage and synced globally via Zustand store - **Documentation Refresh:** Updated README, ARCHITECTURE, FEATURES, AGENTS.md, and API_REFERENCE for v3.6.2 with accurate provider counts (100+), new executor list, and system API documentation -- **Uninstall Guide:** Created comprehensive `docs/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) +- **Uninstall Guide:** Created comprehensive `docs/guides/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) ### 🐛 Bug Fixes diff --git a/docs/i18n/hu/CONTRIBUTING.md b/docs/i18n/hu/CONTRIBUTING.md index ce8e5b0845..d9c56d890e 100644 --- a/docs/i18n/hu/CONTRIBUTING.md +++ b/docs/i18n/hu/CONTRIBUTING.md @@ -153,7 +153,7 @@ Coverage notes: - If a PR changes production code in `src/`, `open-sse/`, `electron/`, or `bin/`, it must add or update automated tests in the same PR - `npm run coverage:report` prints the detailed file-by-file report from the latest coverage run - `npm run test:coverage:legacy` preserves the older metric for historical comparison -- See `docs/COVERAGE_PLAN.md` for the phased coverage improvement roadmap +- See `docs/ops/COVERAGE_PLAN.md` for the phased coverage improvement roadmap ### Pull Request Requirements @@ -305,7 +305,7 @@ Releases are managed via the `/generate-release` workflow. When a new GitHub Rel ## Getting Help -- **Architecture**: See [`docs/ARCHITECTURE.md`](docs/ARCHITECTURE.md) -- **API Reference**: See [`docs/API_REFERENCE.md`](docs/API_REFERENCE.md) +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](docs/architecture/ARCHITECTURE.md) +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](docs/reference/API_REFERENCE.md) - **Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) - **ADRs**: See `docs/adr/` for architectural decision records diff --git a/docs/i18n/hu/README.md b/docs/i18n/hu/README.md index 97ffb36ab0..2d136ac7bb 100644 --- a/docs/i18n/hu/README.md +++ b/docs/i18n/hu/README.md @@ -2267,25 +2267,25 @@ Se não quiser criar credenciais próprias agora, ainda é possível usar o flux ## Dokumentáció -| Document | Description | -| -------------------------------------------------------- | --------------------------------------------------- | -| [User Guide](docs/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | -| [API Reference](docs/API_REFERENCE.md) | All endpoints with examples | -| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | -| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | -| [Auto-Combo Engine](docs/AUTO-COMBO.md) | 6-factor scoring, mode packs, self-healing | -| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | -| [Troubleshooting](docs/TROUBLESHOOTING.md) | Common problems and solutions | -| [Architecture](docs/ARCHITECTURE.md) | System architecture and internals | -| [Codebase Documentation](docs/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | -| [Uninstall Guide](docs/UNINSTALL.md) | Clean removal for all install methods | -| [Environment Config](docs/ENVIRONMENT.md) | Complete `.env` variables and references | -| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | -| [OpenAPI Spec](docs/openapi.yaml) | OpenAPI 3.0 specification | -| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | -| [VM Deployment](docs/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | -| [Features Gallery](docs/FEATURES.md) | Visual dashboard tour with screenshots | -| [Release Checklist](docs/RELEASE_CHECKLIST.md) | Pre-release validation steps | +| Document | Description | +| --------------------------------------------------------------------- | --------------------------------------------------- | +| [User Guide](docs/guides/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | +| [API Reference](docs/reference/API_REFERENCE.md) | All endpoints with examples | +| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | +| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | +| [Auto-Combo Engine](docs/routing/AUTO-COMBO.md) | 6-factor scoring, mode packs, self-healing | +| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | +| [Troubleshooting](docs/guides/TROUBLESHOOTING.md) | Common problems and solutions | +| [Architecture](docs/architecture/ARCHITECTURE.md) | System architecture and internals | +| [Codebase Documentation](docs/architecture/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | +| [Uninstall Guide](docs/guides/UNINSTALL.md) | Clean removal for all install methods | +| [Environment Config](docs/reference/ENVIRONMENT.md) | Complete `.env` variables and references | +| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | +| [OpenAPI Spec](docs/reference/openapi.yaml) | OpenAPI 3.0 specification | +| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | +| [VM Deployment](docs/ops/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | +| [Features Gallery](docs/guides/FEATURES.md) | Visual dashboard tour with screenshots | +| [Release Checklist](docs/ops/RELEASE_CHECKLIST.md) | Pre-release validation steps | --- diff --git a/docs/i18n/hu/docs/ARCHITECTURE.md b/docs/i18n/hu/docs/architecture/ARCHITECTURE.md similarity index 100% rename from docs/i18n/hu/docs/ARCHITECTURE.md rename to docs/i18n/hu/docs/architecture/ARCHITECTURE.md diff --git a/docs/i18n/hu/docs/CODEBASE_DOCUMENTATION.md b/docs/i18n/hu/docs/architecture/CODEBASE_DOCUMENTATION.md similarity index 100% rename from docs/i18n/hu/docs/CODEBASE_DOCUMENTATION.md rename to docs/i18n/hu/docs/architecture/CODEBASE_DOCUMENTATION.md diff --git a/docs/i18n/hu/docs/A2A-SERVER.md b/docs/i18n/hu/docs/frameworks/A2A-SERVER.md similarity index 100% rename from docs/i18n/hu/docs/A2A-SERVER.md rename to docs/i18n/hu/docs/frameworks/A2A-SERVER.md diff --git a/docs/i18n/hu/docs/MCP-SERVER.md b/docs/i18n/hu/docs/frameworks/MCP-SERVER.md similarity index 100% rename from docs/i18n/hu/docs/MCP-SERVER.md rename to docs/i18n/hu/docs/frameworks/MCP-SERVER.md diff --git a/docs/i18n/hu/docs/FEATURES.md b/docs/i18n/hu/docs/guides/FEATURES.md similarity index 100% rename from docs/i18n/hu/docs/FEATURES.md rename to docs/i18n/hu/docs/guides/FEATURES.md diff --git a/docs/i18n/hu/docs/I18N.md b/docs/i18n/hu/docs/guides/I18N.md similarity index 99% rename from docs/i18n/hu/docs/I18N.md rename to docs/i18n/hu/docs/guides/I18N.md index 0b698c8c1e..5ce84e3a10 100644 --- a/docs/i18n/hu/docs/I18N.md +++ b/docs/i18n/hu/docs/guides/I18N.md @@ -420,7 +420,7 @@ The generator originally used `code: "in"` (deprecated Google Translate code) fo ### `docs/i18n/README.md` Is Auto-Generated -The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/I18N.md` (this file) for hand-written documentation that should persist. +The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/guides/I18N.md` (this file) for hand-written documentation that should persist. ### External Untranslatable Keys List diff --git a/docs/i18n/hu/docs/TROUBLESHOOTING.md b/docs/i18n/hu/docs/guides/TROUBLESHOOTING.md similarity index 98% rename from docs/i18n/hu/docs/TROUBLESHOOTING.md rename to docs/i18n/hu/docs/guides/TROUBLESHOOTING.md index b778c8e1dd..ab2f0809e0 100644 --- a/docs/i18n/hu/docs/TROUBLESHOOTING.md +++ b/docs/i18n/hu/docs/guides/TROUBLESHOOTING.md @@ -335,7 +335,7 @@ You can ignore this section if you do not run RAG or agent pipelines behind Omni ## Still Stuck? - **GitHub Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) -- **Architecture**: See [`docs/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details -- **API Reference**: See [`docs/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints - **Health Dashboard**: Check **Dashboard → Health** for real-time system status - **Translator**: Use **Dashboard → Translator** to debug format issues diff --git a/docs/i18n/hu/docs/UNINSTALL.md b/docs/i18n/hu/docs/guides/UNINSTALL.md similarity index 100% rename from docs/i18n/hu/docs/UNINSTALL.md rename to docs/i18n/hu/docs/guides/UNINSTALL.md diff --git a/docs/i18n/hu/docs/USER_GUIDE.md b/docs/i18n/hu/docs/guides/USER_GUIDE.md similarity index 100% rename from docs/i18n/hu/docs/USER_GUIDE.md rename to docs/i18n/hu/docs/guides/USER_GUIDE.md diff --git a/docs/i18n/hu/docs/COVERAGE_PLAN.md b/docs/i18n/hu/docs/ops/COVERAGE_PLAN.md similarity index 100% rename from docs/i18n/hu/docs/COVERAGE_PLAN.md rename to docs/i18n/hu/docs/ops/COVERAGE_PLAN.md diff --git a/docs/i18n/hu/docs/FLY_IO_DEPLOYMENT_GUIDE.md b/docs/i18n/hu/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/hu/docs/FLY_IO_DEPLOYMENT_GUIDE.md rename to docs/i18n/hu/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/hu/docs/RELEASE_CHECKLIST.md b/docs/i18n/hu/docs/ops/RELEASE_CHECKLIST.md similarity index 94% rename from docs/i18n/hu/docs/RELEASE_CHECKLIST.md rename to docs/i18n/hu/docs/ops/RELEASE_CHECKLIST.md index 338230d9a7..87e24c3438 100644 --- a/docs/i18n/hu/docs/RELEASE_CHECKLIST.md +++ b/docs/i18n/hu/docs/ops/RELEASE_CHECKLIST.md @@ -16,14 +16,14 @@ Use this checklist before tagging or publishing a new OmniRoute release. ## API Docs -1. Update `docs/openapi.yaml`: +1. Update `docs/reference/openapi.yaml`: - `info.version` must equal `package.json` version. 2. Validate endpoint examples if API contracts changed. ## Runtime Docs -1. Review `docs/ARCHITECTURE.md` for storage/runtime drift. -2. Review `docs/TROUBLESHOOTING.md` for env var and operational drift. +1. Review `docs/architecture/ARCHITECTURE.md` for storage/runtime drift. +2. Review `docs/guides/TROUBLESHOOTING.md` for env var and operational drift. 3. Verify the release/runtime Node.js version still satisfies the supported secure floor: - `>=20.20.2 <21` or `>=22.22.2 <23` - `npm run check:node-runtime` diff --git a/docs/i18n/hu/docs/VM_DEPLOYMENT_GUIDE.md b/docs/i18n/hu/docs/ops/VM_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/hu/docs/VM_DEPLOYMENT_GUIDE.md rename to docs/i18n/hu/docs/ops/VM_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/hu/docs/API_REFERENCE.md b/docs/i18n/hu/docs/reference/API_REFERENCE.md similarity index 100% rename from docs/i18n/hu/docs/API_REFERENCE.md rename to docs/i18n/hu/docs/reference/API_REFERENCE.md diff --git a/docs/i18n/hu/docs/CLI-TOOLS.md b/docs/i18n/hu/docs/reference/CLI-TOOLS.md similarity index 100% rename from docs/i18n/hu/docs/CLI-TOOLS.md rename to docs/i18n/hu/docs/reference/CLI-TOOLS.md diff --git a/docs/i18n/hu/docs/ENVIRONMENT.md b/docs/i18n/hu/docs/reference/ENVIRONMENT.md similarity index 100% rename from docs/i18n/hu/docs/ENVIRONMENT.md rename to docs/i18n/hu/docs/reference/ENVIRONMENT.md diff --git a/docs/i18n/hu/docs/AUTO-COMBO.md b/docs/i18n/hu/docs/routing/AUTO-COMBO.md similarity index 100% rename from docs/i18n/hu/docs/AUTO-COMBO.md rename to docs/i18n/hu/docs/routing/AUTO-COMBO.md diff --git a/docs/i18n/hu/llm.txt b/docs/i18n/hu/llm.txt index 962b33e890..a5174b82ba 100644 --- a/docs/i18n/hu/llm.txt +++ b/docs/i18n/hu/llm.txt @@ -357,11 +357,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### MCP Server (37 Tools) | Category | Tools | |------------|-------| -| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/MCP-SERVER.md` for full inventory) | +| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/frameworks/MCP-SERVER.md` for full inventory) | | Memory (3) | `memory_search`, `memory_add`, `memory_clear` | | Skills (4) | `skills_list`, `skills_enable`, `skills_execute`, `skills_executions` | -**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/MCP-SERVER.md`. +**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/frameworks/MCP-SERVER.md`. ### Provider Categories @@ -472,7 +472,7 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo 20. **Guardrails framework** in `src/lib/guardrails/` — hot-reloadable registry. Built-ins (priority-ordered): `vision-bridge` (5) → `pii-masker` (10) → `prompt-injection` (20). Fail-open model: exceptions never block traffic. Per-request opt-out via `x-omniroute-disabled-guardrails` header. -21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/AUTHZ_GUIDE.md`. +21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/architecture/AUTHZ_GUIDE.md`. 22. **Three resilience layers** are distinct (do not conflate them): - **Provider Circuit Breaker** (`src/shared/utils/circuitBreaker.ts`) — whole-provider scope. @@ -489,11 +489,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo - **MCP server expanded to 37 tools** (30 base + 3 memory + 4 skills) across ~13 scopes - **OAuth providers expanded to 14**: added Qwen, Kiro, Qoder, Gemini, Windsurf, GitLab Duo - **Coverage gate raised to 75/75/75/70** (was 60% across the board) — measured ~82% -- **Reasoning replay** (`docs/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams +- **Reasoning replay** (`docs/routing/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams - **Compliance + Evals + Webhooks** documentation introduced -- **Stealth guide** (`docs/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration -- **Tunnels guide** (`docs/TUNNELS_GUIDE.md`) — Cloudflare tunnel management -- **Electron guide** (`docs/ELECTRON_GUIDE.md`) — desktop app build + signing +- **Stealth guide** (`docs/security/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration +- **Tunnels guide** (`docs/ops/TUNNELS_GUIDE.md`) — Cloudflare tunnel management +- **Electron guide** (`docs/guides/ELECTRON_GUIDE.md`) — desktop app build + signing ## Links @@ -505,11 +505,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### Documentation Index -- **Architecture & Reference**: `docs/ARCHITECTURE.md`, `docs/CODEBASE_DOCUMENTATION.md`, `docs/REPOSITORY_MAP.md`, `docs/API_REFERENCE.md`, `docs/PROVIDER_REFERENCE.md`, `docs/openapi.yaml` -- **Operator guides**: `docs/USER_GUIDE.md`, `docs/CLI-TOOLS.md`, `docs/TROUBLESHOOTING.md`, `docs/COVERAGE_PLAN.md` -- **Protocols**: `docs/MCP-SERVER.md`, `docs/A2A-SERVER.md`, `docs/AGENT_PROTOCOLS_GUIDE.md`, `docs/CLOUD_AGENT.md` -- **Routing & resilience**: `docs/AUTO-COMBO.md`, `docs/RESILIENCE_GUIDE.md` -- **Security**: `docs/AUTHZ_GUIDE.md`, `docs/GUARDRAILS.md`, `docs/COMPLIANCE.md`, `docs/STEALTH_GUIDE.md` -- **Extensibility**: `docs/SKILLS.md`, `docs/MEMORY.md`, `docs/EVALS.md`, `docs/WEBHOOKS.md`, `docs/REASONING_REPLAY.md` -- **Platform**: `docs/ELECTRON_GUIDE.md`, `docs/TUNNELS_GUIDE.md` +- **Architecture & Reference**: `docs/architecture/ARCHITECTURE.md`, `docs/architecture/CODEBASE_DOCUMENTATION.md`, `docs/architecture/REPOSITORY_MAP.md`, `docs/reference/API_REFERENCE.md`, `docs/reference/PROVIDER_REFERENCE.md`, `docs/reference/openapi.yaml` +- **Operator guides**: `docs/guides/USER_GUIDE.md`, `docs/reference/CLI-TOOLS.md`, `docs/guides/TROUBLESHOOTING.md`, `docs/ops/COVERAGE_PLAN.md` +- **Protocols**: `docs/frameworks/MCP-SERVER.md`, `docs/frameworks/A2A-SERVER.md`, `docs/frameworks/AGENT_PROTOCOLS_GUIDE.md`, `docs/frameworks/CLOUD_AGENT.md` +- **Routing & resilience**: `docs/routing/AUTO-COMBO.md`, `docs/architecture/RESILIENCE_GUIDE.md` +- **Security**: `docs/architecture/AUTHZ_GUIDE.md`, `docs/security/GUARDRAILS.md`, `docs/security/COMPLIANCE.md`, `docs/security/STEALTH_GUIDE.md` +- **Extensibility**: `docs/frameworks/SKILLS.md`, `docs/frameworks/MEMORY.md`, `docs/frameworks/EVALS.md`, `docs/frameworks/WEBHOOKS.md`, `docs/routing/REASONING_REPLAY.md` +- **Platform**: `docs/guides/ELECTRON_GUIDE.md`, `docs/ops/TUNNELS_GUIDE.md` - **AI agents**: `CLAUDE.md`, `AGENTS.md`, `GEMINI.md` diff --git a/docs/i18n/id/CHANGELOG.md b/docs/i18n/id/CHANGELOG.md index b1753e51e4..d66c092655 100644 --- a/docs/i18n/id/CHANGELOG.md +++ b/docs/i18n/id/CHANGELOG.md @@ -1310,7 +1310,7 @@ We identified that **155 community PRs** across the entire project history (from - **33 New API Key Providers:** Massive provider expansion adding DeepInfra, Vercel AI Gateway, Lambda AI, SambaNova, nScale, OVHcloud AI, Baseten, PublicAI, Moonshot AI, Meta Llama API, v0 (Vercel), Morph, Featherless AI, FriendliAI, LlamaGate, Galadriel, Weights & Biases Inference, Volcengine, AI21 Labs, Venice.ai, Codestral, Upstage, Maritalk, Xiaomi MiMo, Inference.net, NanoGPT, Predibase, Bytez, Heroku AI, Databricks, Snowflake Cortex, and GigaChat (Sber). OmniRoute now supports **100+ providers** (4 Free + 8 OAuth + 91 API Key + Custom compatible) - **Global Email Privacy Toggle:** Added a persistent eye-icon toggle button across all dashboard pages (Providers, Usage Limits, Playground) that reveals or hides masked email addresses. Toggle state is stored in localStorage and synced globally via Zustand store - **Documentation Refresh:** Updated README, ARCHITECTURE, FEATURES, AGENTS.md, and API_REFERENCE for v3.6.2 with accurate provider counts (100+), new executor list, and system API documentation -- **Uninstall Guide:** Created comprehensive `docs/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) +- **Uninstall Guide:** Created comprehensive `docs/guides/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) ### 🐛 Bug Fixes diff --git a/docs/i18n/id/CONTRIBUTING.md b/docs/i18n/id/CONTRIBUTING.md index b3ffe11a1b..b1a724553a 100644 --- a/docs/i18n/id/CONTRIBUTING.md +++ b/docs/i18n/id/CONTRIBUTING.md @@ -153,7 +153,7 @@ Coverage notes: - If a PR changes production code in `src/`, `open-sse/`, `electron/`, or `bin/`, it must add or update automated tests in the same PR - `npm run coverage:report` prints the detailed file-by-file report from the latest coverage run - `npm run test:coverage:legacy` preserves the older metric for historical comparison -- See `docs/COVERAGE_PLAN.md` for the phased coverage improvement roadmap +- See `docs/ops/COVERAGE_PLAN.md` for the phased coverage improvement roadmap ### Pull Request Requirements @@ -305,7 +305,7 @@ Releases are managed via the `/generate-release` workflow. When a new GitHub Rel ## Getting Help -- **Architecture**: See [`docs/ARCHITECTURE.md`](docs/ARCHITECTURE.md) -- **API Reference**: See [`docs/API_REFERENCE.md`](docs/API_REFERENCE.md) +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](docs/architecture/ARCHITECTURE.md) +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](docs/reference/API_REFERENCE.md) - **Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) - **ADRs**: See `docs/adr/` for architectural decision records diff --git a/docs/i18n/id/README.md b/docs/i18n/id/README.md index e308128367..71d5194ecd 100644 --- a/docs/i18n/id/README.md +++ b/docs/i18n/id/README.md @@ -2267,25 +2267,25 @@ Se não quiser criar credenciais próprias agora, ainda é possível usar o flux ## Dokumentasi -| Document | Description | -| -------------------------------------------------------- | --------------------------------------------------- | -| [User Guide](docs/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | -| [API Reference](docs/API_REFERENCE.md) | All endpoints with examples | -| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | -| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | -| [Auto-Combo Engine](docs/AUTO-COMBO.md) | 6-factor scoring, mode packs, self-healing | -| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | -| [Troubleshooting](docs/TROUBLESHOOTING.md) | Common problems and solutions | -| [Architecture](docs/ARCHITECTURE.md) | System architecture and internals | -| [Codebase Documentation](docs/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | -| [Uninstall Guide](docs/UNINSTALL.md) | Clean removal for all install methods | -| [Environment Config](docs/ENVIRONMENT.md) | Complete `.env` variables and references | -| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | -| [OpenAPI Spec](docs/openapi.yaml) | OpenAPI 3.0 specification | -| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | -| [VM Deployment](docs/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | -| [Features Gallery](docs/FEATURES.md) | Visual dashboard tour with screenshots | -| [Release Checklist](docs/RELEASE_CHECKLIST.md) | Pre-release validation steps | +| Document | Description | +| --------------------------------------------------------------------- | --------------------------------------------------- | +| [User Guide](docs/guides/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | +| [API Reference](docs/reference/API_REFERENCE.md) | All endpoints with examples | +| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | +| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | +| [Auto-Combo Engine](docs/routing/AUTO-COMBO.md) | 6-factor scoring, mode packs, self-healing | +| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | +| [Troubleshooting](docs/guides/TROUBLESHOOTING.md) | Common problems and solutions | +| [Architecture](docs/architecture/ARCHITECTURE.md) | System architecture and internals | +| [Codebase Documentation](docs/architecture/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | +| [Uninstall Guide](docs/guides/UNINSTALL.md) | Clean removal for all install methods | +| [Environment Config](docs/reference/ENVIRONMENT.md) | Complete `.env` variables and references | +| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | +| [OpenAPI Spec](docs/reference/openapi.yaml) | OpenAPI 3.0 specification | +| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | +| [VM Deployment](docs/ops/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | +| [Features Gallery](docs/guides/FEATURES.md) | Visual dashboard tour with screenshots | +| [Release Checklist](docs/ops/RELEASE_CHECKLIST.md) | Pre-release validation steps | --- diff --git a/docs/i18n/id/docs/ARCHITECTURE.md b/docs/i18n/id/docs/architecture/ARCHITECTURE.md similarity index 100% rename from docs/i18n/id/docs/ARCHITECTURE.md rename to docs/i18n/id/docs/architecture/ARCHITECTURE.md diff --git a/docs/i18n/id/docs/CODEBASE_DOCUMENTATION.md b/docs/i18n/id/docs/architecture/CODEBASE_DOCUMENTATION.md similarity index 100% rename from docs/i18n/id/docs/CODEBASE_DOCUMENTATION.md rename to docs/i18n/id/docs/architecture/CODEBASE_DOCUMENTATION.md diff --git a/docs/i18n/id/docs/A2A-SERVER.md b/docs/i18n/id/docs/frameworks/A2A-SERVER.md similarity index 100% rename from docs/i18n/id/docs/A2A-SERVER.md rename to docs/i18n/id/docs/frameworks/A2A-SERVER.md diff --git a/docs/i18n/id/docs/MCP-SERVER.md b/docs/i18n/id/docs/frameworks/MCP-SERVER.md similarity index 100% rename from docs/i18n/id/docs/MCP-SERVER.md rename to docs/i18n/id/docs/frameworks/MCP-SERVER.md diff --git a/docs/i18n/id/docs/FEATURES.md b/docs/i18n/id/docs/guides/FEATURES.md similarity index 100% rename from docs/i18n/id/docs/FEATURES.md rename to docs/i18n/id/docs/guides/FEATURES.md diff --git a/docs/i18n/id/docs/I18N.md b/docs/i18n/id/docs/guides/I18N.md similarity index 99% rename from docs/i18n/id/docs/I18N.md rename to docs/i18n/id/docs/guides/I18N.md index 77df794c42..910370dcae 100644 --- a/docs/i18n/id/docs/I18N.md +++ b/docs/i18n/id/docs/guides/I18N.md @@ -420,7 +420,7 @@ The generator originally used `code: "in"` (deprecated Google Translate code) fo ### `docs/i18n/README.md` Is Auto-Generated -The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/I18N.md` (this file) for hand-written documentation that should persist. +The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/guides/I18N.md` (this file) for hand-written documentation that should persist. ### External Untranslatable Keys List diff --git a/docs/i18n/id/docs/TROUBLESHOOTING.md b/docs/i18n/id/docs/guides/TROUBLESHOOTING.md similarity index 98% rename from docs/i18n/id/docs/TROUBLESHOOTING.md rename to docs/i18n/id/docs/guides/TROUBLESHOOTING.md index 8c07300e1b..ae8156e5ef 100644 --- a/docs/i18n/id/docs/TROUBLESHOOTING.md +++ b/docs/i18n/id/docs/guides/TROUBLESHOOTING.md @@ -335,7 +335,7 @@ You can ignore this section if you do not run RAG or agent pipelines behind Omni ## Still Stuck? - **GitHub Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) -- **Architecture**: See [`docs/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details -- **API Reference**: See [`docs/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints - **Health Dashboard**: Check **Dashboard → Health** for real-time system status - **Translator**: Use **Dashboard → Translator** to debug format issues diff --git a/docs/i18n/id/docs/UNINSTALL.md b/docs/i18n/id/docs/guides/UNINSTALL.md similarity index 100% rename from docs/i18n/id/docs/UNINSTALL.md rename to docs/i18n/id/docs/guides/UNINSTALL.md diff --git a/docs/i18n/id/docs/USER_GUIDE.md b/docs/i18n/id/docs/guides/USER_GUIDE.md similarity index 100% rename from docs/i18n/id/docs/USER_GUIDE.md rename to docs/i18n/id/docs/guides/USER_GUIDE.md diff --git a/docs/i18n/id/docs/COVERAGE_PLAN.md b/docs/i18n/id/docs/ops/COVERAGE_PLAN.md similarity index 100% rename from docs/i18n/id/docs/COVERAGE_PLAN.md rename to docs/i18n/id/docs/ops/COVERAGE_PLAN.md diff --git a/docs/i18n/id/docs/FLY_IO_DEPLOYMENT_GUIDE.md b/docs/i18n/id/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/id/docs/FLY_IO_DEPLOYMENT_GUIDE.md rename to docs/i18n/id/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/id/docs/RELEASE_CHECKLIST.md b/docs/i18n/id/docs/ops/RELEASE_CHECKLIST.md similarity index 94% rename from docs/i18n/id/docs/RELEASE_CHECKLIST.md rename to docs/i18n/id/docs/ops/RELEASE_CHECKLIST.md index a0126b813b..f57f20d897 100644 --- a/docs/i18n/id/docs/RELEASE_CHECKLIST.md +++ b/docs/i18n/id/docs/ops/RELEASE_CHECKLIST.md @@ -16,14 +16,14 @@ Use this checklist before tagging or publishing a new OmniRoute release. ## API Docs -1. Update `docs/openapi.yaml`: +1. Update `docs/reference/openapi.yaml`: - `info.version` must equal `package.json` version. 2. Validate endpoint examples if API contracts changed. ## Runtime Docs -1. Review `docs/ARCHITECTURE.md` for storage/runtime drift. -2. Review `docs/TROUBLESHOOTING.md` for env var and operational drift. +1. Review `docs/architecture/ARCHITECTURE.md` for storage/runtime drift. +2. Review `docs/guides/TROUBLESHOOTING.md` for env var and operational drift. 3. Verify the release/runtime Node.js version still satisfies the supported secure floor: - `>=20.20.2 <21` or `>=22.22.2 <23` - `npm run check:node-runtime` diff --git a/docs/i18n/id/docs/VM_DEPLOYMENT_GUIDE.md b/docs/i18n/id/docs/ops/VM_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/id/docs/VM_DEPLOYMENT_GUIDE.md rename to docs/i18n/id/docs/ops/VM_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/id/docs/API_REFERENCE.md b/docs/i18n/id/docs/reference/API_REFERENCE.md similarity index 100% rename from docs/i18n/id/docs/API_REFERENCE.md rename to docs/i18n/id/docs/reference/API_REFERENCE.md diff --git a/docs/i18n/id/docs/CLI-TOOLS.md b/docs/i18n/id/docs/reference/CLI-TOOLS.md similarity index 100% rename from docs/i18n/id/docs/CLI-TOOLS.md rename to docs/i18n/id/docs/reference/CLI-TOOLS.md diff --git a/docs/i18n/id/docs/ENVIRONMENT.md b/docs/i18n/id/docs/reference/ENVIRONMENT.md similarity index 100% rename from docs/i18n/id/docs/ENVIRONMENT.md rename to docs/i18n/id/docs/reference/ENVIRONMENT.md diff --git a/docs/i18n/id/docs/AUTO-COMBO.md b/docs/i18n/id/docs/routing/AUTO-COMBO.md similarity index 100% rename from docs/i18n/id/docs/AUTO-COMBO.md rename to docs/i18n/id/docs/routing/AUTO-COMBO.md diff --git a/docs/i18n/id/llm.txt b/docs/i18n/id/llm.txt index dc159223f9..a7326adc95 100644 --- a/docs/i18n/id/llm.txt +++ b/docs/i18n/id/llm.txt @@ -357,11 +357,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### MCP Server (37 Tools) | Category | Tools | |------------|-------| -| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/MCP-SERVER.md` for full inventory) | +| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/frameworks/MCP-SERVER.md` for full inventory) | | Memory (3) | `memory_search`, `memory_add`, `memory_clear` | | Skills (4) | `skills_list`, `skills_enable`, `skills_execute`, `skills_executions` | -**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/MCP-SERVER.md`. +**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/frameworks/MCP-SERVER.md`. ### Provider Categories @@ -472,7 +472,7 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo 20. **Guardrails framework** in `src/lib/guardrails/` — hot-reloadable registry. Built-ins (priority-ordered): `vision-bridge` (5) → `pii-masker` (10) → `prompt-injection` (20). Fail-open model: exceptions never block traffic. Per-request opt-out via `x-omniroute-disabled-guardrails` header. -21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/AUTHZ_GUIDE.md`. +21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/architecture/AUTHZ_GUIDE.md`. 22. **Three resilience layers** are distinct (do not conflate them): - **Provider Circuit Breaker** (`src/shared/utils/circuitBreaker.ts`) — whole-provider scope. @@ -489,11 +489,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo - **MCP server expanded to 37 tools** (30 base + 3 memory + 4 skills) across ~13 scopes - **OAuth providers expanded to 14**: added Qwen, Kiro, Qoder, Gemini, Windsurf, GitLab Duo - **Coverage gate raised to 75/75/75/70** (was 60% across the board) — measured ~82% -- **Reasoning replay** (`docs/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams +- **Reasoning replay** (`docs/routing/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams - **Compliance + Evals + Webhooks** documentation introduced -- **Stealth guide** (`docs/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration -- **Tunnels guide** (`docs/TUNNELS_GUIDE.md`) — Cloudflare tunnel management -- **Electron guide** (`docs/ELECTRON_GUIDE.md`) — desktop app build + signing +- **Stealth guide** (`docs/security/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration +- **Tunnels guide** (`docs/ops/TUNNELS_GUIDE.md`) — Cloudflare tunnel management +- **Electron guide** (`docs/guides/ELECTRON_GUIDE.md`) — desktop app build + signing ## Links @@ -505,11 +505,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### Documentation Index -- **Architecture & Reference**: `docs/ARCHITECTURE.md`, `docs/CODEBASE_DOCUMENTATION.md`, `docs/REPOSITORY_MAP.md`, `docs/API_REFERENCE.md`, `docs/PROVIDER_REFERENCE.md`, `docs/openapi.yaml` -- **Operator guides**: `docs/USER_GUIDE.md`, `docs/CLI-TOOLS.md`, `docs/TROUBLESHOOTING.md`, `docs/COVERAGE_PLAN.md` -- **Protocols**: `docs/MCP-SERVER.md`, `docs/A2A-SERVER.md`, `docs/AGENT_PROTOCOLS_GUIDE.md`, `docs/CLOUD_AGENT.md` -- **Routing & resilience**: `docs/AUTO-COMBO.md`, `docs/RESILIENCE_GUIDE.md` -- **Security**: `docs/AUTHZ_GUIDE.md`, `docs/GUARDRAILS.md`, `docs/COMPLIANCE.md`, `docs/STEALTH_GUIDE.md` -- **Extensibility**: `docs/SKILLS.md`, `docs/MEMORY.md`, `docs/EVALS.md`, `docs/WEBHOOKS.md`, `docs/REASONING_REPLAY.md` -- **Platform**: `docs/ELECTRON_GUIDE.md`, `docs/TUNNELS_GUIDE.md` +- **Architecture & Reference**: `docs/architecture/ARCHITECTURE.md`, `docs/architecture/CODEBASE_DOCUMENTATION.md`, `docs/architecture/REPOSITORY_MAP.md`, `docs/reference/API_REFERENCE.md`, `docs/reference/PROVIDER_REFERENCE.md`, `docs/reference/openapi.yaml` +- **Operator guides**: `docs/guides/USER_GUIDE.md`, `docs/reference/CLI-TOOLS.md`, `docs/guides/TROUBLESHOOTING.md`, `docs/ops/COVERAGE_PLAN.md` +- **Protocols**: `docs/frameworks/MCP-SERVER.md`, `docs/frameworks/A2A-SERVER.md`, `docs/frameworks/AGENT_PROTOCOLS_GUIDE.md`, `docs/frameworks/CLOUD_AGENT.md` +- **Routing & resilience**: `docs/routing/AUTO-COMBO.md`, `docs/architecture/RESILIENCE_GUIDE.md` +- **Security**: `docs/architecture/AUTHZ_GUIDE.md`, `docs/security/GUARDRAILS.md`, `docs/security/COMPLIANCE.md`, `docs/security/STEALTH_GUIDE.md` +- **Extensibility**: `docs/frameworks/SKILLS.md`, `docs/frameworks/MEMORY.md`, `docs/frameworks/EVALS.md`, `docs/frameworks/WEBHOOKS.md`, `docs/routing/REASONING_REPLAY.md` +- **Platform**: `docs/guides/ELECTRON_GUIDE.md`, `docs/ops/TUNNELS_GUIDE.md` - **AI agents**: `CLAUDE.md`, `AGENTS.md`, `GEMINI.md` diff --git a/docs/i18n/in/CHANGELOG.md b/docs/i18n/in/CHANGELOG.md index 5fff2412bf..8af184dd43 100644 --- a/docs/i18n/in/CHANGELOG.md +++ b/docs/i18n/in/CHANGELOG.md @@ -1196,7 +1196,7 @@ We identified that **155 community PRs** across the entire project history (from - **33 New API Key Providers:** Massive provider expansion adding DeepInfra, Vercel AI Gateway, Lambda AI, SambaNova, nScale, OVHcloud AI, Baseten, PublicAI, Moonshot AI, Meta Llama API, v0 (Vercel), Morph, Featherless AI, FriendliAI, LlamaGate, Galadriel, Weights & Biases Inference, Volcengine, AI21 Labs, Venice.ai, Codestral, Upstage, Maritalk, Xiaomi MiMo, Inference.net, NanoGPT, Predibase, Bytez, Heroku AI, Databricks, Snowflake Cortex, and GigaChat (Sber). OmniRoute now supports **100+ providers** (4 Free + 8 OAuth + 91 API Key + Custom compatible) - **Global Email Privacy Toggle:** Added a persistent eye-icon toggle button across all dashboard pages (Providers, Usage Limits, Playground) that reveals or hides masked email addresses. Toggle state is stored in localStorage and synced globally via Zustand store - **Documentation Refresh:** Updated README, ARCHITECTURE, FEATURES, AGENTS.md, and API_REFERENCE for v3.6.2 with accurate provider counts (100+), new executor list, and system API documentation -- **Uninstall Guide:** Created comprehensive `docs/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) +- **Uninstall Guide:** Created comprehensive `docs/guides/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) ### 🐛 Bug Fixes diff --git a/docs/i18n/in/CONTRIBUTING.md b/docs/i18n/in/CONTRIBUTING.md index 8aa93179c3..da6c1d8ac0 100644 --- a/docs/i18n/in/CONTRIBUTING.md +++ b/docs/i18n/in/CONTRIBUTING.md @@ -153,7 +153,7 @@ Coverage notes: - If a PR changes production code in `src/`, `open-sse/`, `electron/`, or `bin/`, it must add or update automated tests in the same PR - `npm run coverage:report` prints the detailed file-by-file report from the latest coverage run - `npm run test:coverage:legacy` preserves the older metric for historical comparison -- See `docs/COVERAGE_PLAN.md` for the phased coverage improvement roadmap +- See `docs/ops/COVERAGE_PLAN.md` for the phased coverage improvement roadmap ### Pull Request Requirements @@ -305,7 +305,7 @@ Releases are managed via the `/generate-release` workflow. When a new GitHub Rel ## Getting Help -- **Architecture**: See [`docs/ARCHITECTURE.md`](docs/ARCHITECTURE.md) -- **API Reference**: See [`docs/API_REFERENCE.md`](docs/API_REFERENCE.md) +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](docs/architecture/ARCHITECTURE.md) +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](docs/reference/API_REFERENCE.md) - **Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) - **ADRs**: See `docs/adr/` for architectural decision records diff --git a/docs/i18n/in/README.md b/docs/i18n/in/README.md index 70c65182ff..486d3210ce 100644 --- a/docs/i18n/in/README.md +++ b/docs/i18n/in/README.md @@ -2256,25 +2256,25 @@ Se não quiser criar credenciais próprias agora, ainda é possível usar o flux ## दस्तावेज़ -| Document | Description | -| -------------------------------------------------------- | --------------------------------------------------- | -| [User Guide](docs/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | -| [API Reference](docs/API_REFERENCE.md) | All endpoints with examples | -| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | -| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | -| [Auto-Combo Engine](docs/AUTO-COMBO.md) | 6-factor scoring, mode packs, self-healing | -| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | -| [Troubleshooting](docs/TROUBLESHOOTING.md) | Common problems and solutions | -| [Architecture](docs/ARCHITECTURE.md) | System architecture and internals | -| [Codebase Documentation](docs/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | -| [Uninstall Guide](docs/UNINSTALL.md) | Clean removal for all install methods | -| [Environment Config](docs/ENVIRONMENT.md) | Complete `.env` variables and references | -| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | -| [OpenAPI Spec](docs/openapi.yaml) | OpenAPI 3.0 specification | -| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | -| [VM Deployment](docs/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | -| [Features Gallery](docs/FEATURES.md) | Visual dashboard tour with screenshots | -| [Release Checklist](docs/RELEASE_CHECKLIST.md) | Pre-release validation steps | +| Document | Description | +| --------------------------------------------------------------------- | --------------------------------------------------- | +| [User Guide](docs/guides/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | +| [API Reference](docs/reference/API_REFERENCE.md) | All endpoints with examples | +| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | +| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | +| [Auto-Combo Engine](docs/routing/AUTO-COMBO.md) | 6-factor scoring, mode packs, self-healing | +| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | +| [Troubleshooting](docs/guides/TROUBLESHOOTING.md) | Common problems and solutions | +| [Architecture](docs/architecture/ARCHITECTURE.md) | System architecture and internals | +| [Codebase Documentation](docs/architecture/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | +| [Uninstall Guide](docs/guides/UNINSTALL.md) | Clean removal for all install methods | +| [Environment Config](docs/reference/ENVIRONMENT.md) | Complete `.env` variables and references | +| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | +| [OpenAPI Spec](docs/reference/openapi.yaml) | OpenAPI 3.0 specification | +| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | +| [VM Deployment](docs/ops/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | +| [Features Gallery](docs/guides/FEATURES.md) | Visual dashboard tour with screenshots | +| [Release Checklist](docs/ops/RELEASE_CHECKLIST.md) | Pre-release validation steps | --- diff --git a/docs/i18n/in/docs/ARCHITECTURE.md b/docs/i18n/in/docs/architecture/ARCHITECTURE.md similarity index 100% rename from docs/i18n/in/docs/ARCHITECTURE.md rename to docs/i18n/in/docs/architecture/ARCHITECTURE.md diff --git a/docs/i18n/in/docs/CODEBASE_DOCUMENTATION.md b/docs/i18n/in/docs/architecture/CODEBASE_DOCUMENTATION.md similarity index 100% rename from docs/i18n/in/docs/CODEBASE_DOCUMENTATION.md rename to docs/i18n/in/docs/architecture/CODEBASE_DOCUMENTATION.md diff --git a/docs/i18n/in/docs/A2A-SERVER.md b/docs/i18n/in/docs/frameworks/A2A-SERVER.md similarity index 100% rename from docs/i18n/in/docs/A2A-SERVER.md rename to docs/i18n/in/docs/frameworks/A2A-SERVER.md diff --git a/docs/i18n/in/docs/MCP-SERVER.md b/docs/i18n/in/docs/frameworks/MCP-SERVER.md similarity index 100% rename from docs/i18n/in/docs/MCP-SERVER.md rename to docs/i18n/in/docs/frameworks/MCP-SERVER.md diff --git a/docs/i18n/in/docs/FEATURES.md b/docs/i18n/in/docs/guides/FEATURES.md similarity index 100% rename from docs/i18n/in/docs/FEATURES.md rename to docs/i18n/in/docs/guides/FEATURES.md diff --git a/docs/i18n/in/docs/I18N.md b/docs/i18n/in/docs/guides/I18N.md similarity index 99% rename from docs/i18n/in/docs/I18N.md rename to docs/i18n/in/docs/guides/I18N.md index 142bd074b2..c2676241d3 100644 --- a/docs/i18n/in/docs/I18N.md +++ b/docs/i18n/in/docs/guides/I18N.md @@ -420,7 +420,7 @@ The generator originally used `code: "in"` (deprecated Google Translate code) fo ### `docs/i18n/README.md` Is Auto-Generated -The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/I18N.md` (this file) for hand-written documentation that should persist. +The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/guides/I18N.md` (this file) for hand-written documentation that should persist. ### External Untranslatable Keys List diff --git a/docs/i18n/in/docs/TROUBLESHOOTING.md b/docs/i18n/in/docs/guides/TROUBLESHOOTING.md similarity index 98% rename from docs/i18n/in/docs/TROUBLESHOOTING.md rename to docs/i18n/in/docs/guides/TROUBLESHOOTING.md index 78a93de8bb..fab97adffe 100644 --- a/docs/i18n/in/docs/TROUBLESHOOTING.md +++ b/docs/i18n/in/docs/guides/TROUBLESHOOTING.md @@ -335,7 +335,7 @@ You can ignore this section if you do not run RAG or agent pipelines behind Omni ## Still Stuck? - **GitHub Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) -- **Architecture**: See [`docs/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details -- **API Reference**: See [`docs/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints - **Health Dashboard**: Check **Dashboard → Health** for real-time system status - **Translator**: Use **Dashboard → Translator** to debug format issues diff --git a/docs/i18n/in/docs/UNINSTALL.md b/docs/i18n/in/docs/guides/UNINSTALL.md similarity index 100% rename from docs/i18n/in/docs/UNINSTALL.md rename to docs/i18n/in/docs/guides/UNINSTALL.md diff --git a/docs/i18n/in/docs/USER_GUIDE.md b/docs/i18n/in/docs/guides/USER_GUIDE.md similarity index 100% rename from docs/i18n/in/docs/USER_GUIDE.md rename to docs/i18n/in/docs/guides/USER_GUIDE.md diff --git a/docs/i18n/in/docs/COVERAGE_PLAN.md b/docs/i18n/in/docs/ops/COVERAGE_PLAN.md similarity index 100% rename from docs/i18n/in/docs/COVERAGE_PLAN.md rename to docs/i18n/in/docs/ops/COVERAGE_PLAN.md diff --git a/docs/i18n/in/docs/FLY_IO_DEPLOYMENT_GUIDE.md b/docs/i18n/in/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/in/docs/FLY_IO_DEPLOYMENT_GUIDE.md rename to docs/i18n/in/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/in/docs/RELEASE_CHECKLIST.md b/docs/i18n/in/docs/ops/RELEASE_CHECKLIST.md similarity index 94% rename from docs/i18n/in/docs/RELEASE_CHECKLIST.md rename to docs/i18n/in/docs/ops/RELEASE_CHECKLIST.md index 21bcce8589..1108a3ad61 100644 --- a/docs/i18n/in/docs/RELEASE_CHECKLIST.md +++ b/docs/i18n/in/docs/ops/RELEASE_CHECKLIST.md @@ -16,14 +16,14 @@ Use this checklist before tagging or publishing a new OmniRoute release. ## API Docs -1. Update `docs/openapi.yaml`: +1. Update `docs/reference/openapi.yaml`: - `info.version` must equal `package.json` version. 2. Validate endpoint examples if API contracts changed. ## Runtime Docs -1. Review `docs/ARCHITECTURE.md` for storage/runtime drift. -2. Review `docs/TROUBLESHOOTING.md` for env var and operational drift. +1. Review `docs/architecture/ARCHITECTURE.md` for storage/runtime drift. +2. Review `docs/guides/TROUBLESHOOTING.md` for env var and operational drift. 3. Verify the release/runtime Node.js version still satisfies the supported secure floor: - `>=20.20.2 <21` or `>=22.22.2 <23` - `npm run check:node-runtime` diff --git a/docs/i18n/in/docs/VM_DEPLOYMENT_GUIDE.md b/docs/i18n/in/docs/ops/VM_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/in/docs/VM_DEPLOYMENT_GUIDE.md rename to docs/i18n/in/docs/ops/VM_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/in/docs/API_REFERENCE.md b/docs/i18n/in/docs/reference/API_REFERENCE.md similarity index 100% rename from docs/i18n/in/docs/API_REFERENCE.md rename to docs/i18n/in/docs/reference/API_REFERENCE.md diff --git a/docs/i18n/in/docs/CLI-TOOLS.md b/docs/i18n/in/docs/reference/CLI-TOOLS.md similarity index 100% rename from docs/i18n/in/docs/CLI-TOOLS.md rename to docs/i18n/in/docs/reference/CLI-TOOLS.md diff --git a/docs/i18n/in/docs/ENVIRONMENT.md b/docs/i18n/in/docs/reference/ENVIRONMENT.md similarity index 100% rename from docs/i18n/in/docs/ENVIRONMENT.md rename to docs/i18n/in/docs/reference/ENVIRONMENT.md diff --git a/docs/i18n/in/docs/AUTO-COMBO.md b/docs/i18n/in/docs/routing/AUTO-COMBO.md similarity index 100% rename from docs/i18n/in/docs/AUTO-COMBO.md rename to docs/i18n/in/docs/routing/AUTO-COMBO.md diff --git a/docs/i18n/in/llm.txt b/docs/i18n/in/llm.txt index dfc141a97c..7a335876a5 100644 --- a/docs/i18n/in/llm.txt +++ b/docs/i18n/in/llm.txt @@ -357,11 +357,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### MCP Server (37 Tools) | Category | Tools | |------------|-------| -| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/MCP-SERVER.md` for full inventory) | +| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/frameworks/MCP-SERVER.md` for full inventory) | | Memory (3) | `memory_search`, `memory_add`, `memory_clear` | | Skills (4) | `skills_list`, `skills_enable`, `skills_execute`, `skills_executions` | -**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/MCP-SERVER.md`. +**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/frameworks/MCP-SERVER.md`. ### Provider Categories @@ -472,7 +472,7 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo 20. **Guardrails framework** in `src/lib/guardrails/` — hot-reloadable registry. Built-ins (priority-ordered): `vision-bridge` (5) → `pii-masker` (10) → `prompt-injection` (20). Fail-open model: exceptions never block traffic. Per-request opt-out via `x-omniroute-disabled-guardrails` header. -21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/AUTHZ_GUIDE.md`. +21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/architecture/AUTHZ_GUIDE.md`. 22. **Three resilience layers** are distinct (do not conflate them): - **Provider Circuit Breaker** (`src/shared/utils/circuitBreaker.ts`) — whole-provider scope. @@ -489,11 +489,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo - **MCP server expanded to 37 tools** (30 base + 3 memory + 4 skills) across ~13 scopes - **OAuth providers expanded to 14**: added Qwen, Kiro, Qoder, Gemini, Windsurf, GitLab Duo - **Coverage gate raised to 75/75/75/70** (was 60% across the board) — measured ~82% -- **Reasoning replay** (`docs/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams +- **Reasoning replay** (`docs/routing/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams - **Compliance + Evals + Webhooks** documentation introduced -- **Stealth guide** (`docs/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration -- **Tunnels guide** (`docs/TUNNELS_GUIDE.md`) — Cloudflare tunnel management -- **Electron guide** (`docs/ELECTRON_GUIDE.md`) — desktop app build + signing +- **Stealth guide** (`docs/security/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration +- **Tunnels guide** (`docs/ops/TUNNELS_GUIDE.md`) — Cloudflare tunnel management +- **Electron guide** (`docs/guides/ELECTRON_GUIDE.md`) — desktop app build + signing ## Links @@ -505,11 +505,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### Documentation Index -- **Architecture & Reference**: `docs/ARCHITECTURE.md`, `docs/CODEBASE_DOCUMENTATION.md`, `docs/REPOSITORY_MAP.md`, `docs/API_REFERENCE.md`, `docs/PROVIDER_REFERENCE.md`, `docs/openapi.yaml` -- **Operator guides**: `docs/USER_GUIDE.md`, `docs/CLI-TOOLS.md`, `docs/TROUBLESHOOTING.md`, `docs/COVERAGE_PLAN.md` -- **Protocols**: `docs/MCP-SERVER.md`, `docs/A2A-SERVER.md`, `docs/AGENT_PROTOCOLS_GUIDE.md`, `docs/CLOUD_AGENT.md` -- **Routing & resilience**: `docs/AUTO-COMBO.md`, `docs/RESILIENCE_GUIDE.md` -- **Security**: `docs/AUTHZ_GUIDE.md`, `docs/GUARDRAILS.md`, `docs/COMPLIANCE.md`, `docs/STEALTH_GUIDE.md` -- **Extensibility**: `docs/SKILLS.md`, `docs/MEMORY.md`, `docs/EVALS.md`, `docs/WEBHOOKS.md`, `docs/REASONING_REPLAY.md` -- **Platform**: `docs/ELECTRON_GUIDE.md`, `docs/TUNNELS_GUIDE.md` +- **Architecture & Reference**: `docs/architecture/ARCHITECTURE.md`, `docs/architecture/CODEBASE_DOCUMENTATION.md`, `docs/architecture/REPOSITORY_MAP.md`, `docs/reference/API_REFERENCE.md`, `docs/reference/PROVIDER_REFERENCE.md`, `docs/reference/openapi.yaml` +- **Operator guides**: `docs/guides/USER_GUIDE.md`, `docs/reference/CLI-TOOLS.md`, `docs/guides/TROUBLESHOOTING.md`, `docs/ops/COVERAGE_PLAN.md` +- **Protocols**: `docs/frameworks/MCP-SERVER.md`, `docs/frameworks/A2A-SERVER.md`, `docs/frameworks/AGENT_PROTOCOLS_GUIDE.md`, `docs/frameworks/CLOUD_AGENT.md` +- **Routing & resilience**: `docs/routing/AUTO-COMBO.md`, `docs/architecture/RESILIENCE_GUIDE.md` +- **Security**: `docs/architecture/AUTHZ_GUIDE.md`, `docs/security/GUARDRAILS.md`, `docs/security/COMPLIANCE.md`, `docs/security/STEALTH_GUIDE.md` +- **Extensibility**: `docs/frameworks/SKILLS.md`, `docs/frameworks/MEMORY.md`, `docs/frameworks/EVALS.md`, `docs/frameworks/WEBHOOKS.md`, `docs/routing/REASONING_REPLAY.md` +- **Platform**: `docs/guides/ELECTRON_GUIDE.md`, `docs/ops/TUNNELS_GUIDE.md` - **AI agents**: `CLAUDE.md`, `AGENTS.md`, `GEMINI.md` diff --git a/docs/i18n/it/CHANGELOG.md b/docs/i18n/it/CHANGELOG.md index 348d38da98..80ed4a317d 100644 --- a/docs/i18n/it/CHANGELOG.md +++ b/docs/i18n/it/CHANGELOG.md @@ -1310,7 +1310,7 @@ We identified that **155 community PRs** across the entire project history (from - **33 New API Key Providers:** Massive provider expansion adding DeepInfra, Vercel AI Gateway, Lambda AI, SambaNova, nScale, OVHcloud AI, Baseten, PublicAI, Moonshot AI, Meta Llama API, v0 (Vercel), Morph, Featherless AI, FriendliAI, LlamaGate, Galadriel, Weights & Biases Inference, Volcengine, AI21 Labs, Venice.ai, Codestral, Upstage, Maritalk, Xiaomi MiMo, Inference.net, NanoGPT, Predibase, Bytez, Heroku AI, Databricks, Snowflake Cortex, and GigaChat (Sber). OmniRoute now supports **100+ providers** (4 Free + 8 OAuth + 91 API Key + Custom compatible) - **Global Email Privacy Toggle:** Added a persistent eye-icon toggle button across all dashboard pages (Providers, Usage Limits, Playground) that reveals or hides masked email addresses. Toggle state is stored in localStorage and synced globally via Zustand store - **Documentation Refresh:** Updated README, ARCHITECTURE, FEATURES, AGENTS.md, and API_REFERENCE for v3.6.2 with accurate provider counts (100+), new executor list, and system API documentation -- **Uninstall Guide:** Created comprehensive `docs/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) +- **Uninstall Guide:** Created comprehensive `docs/guides/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) ### 🐛 Bug Fixes diff --git a/docs/i18n/it/CONTRIBUTING.md b/docs/i18n/it/CONTRIBUTING.md index 98278a77db..e3cb62b317 100644 --- a/docs/i18n/it/CONTRIBUTING.md +++ b/docs/i18n/it/CONTRIBUTING.md @@ -153,7 +153,7 @@ Coverage notes: - If a PR changes production code in `src/`, `open-sse/`, `electron/`, or `bin/`, it must add or update automated tests in the same PR - `npm run coverage:report` prints the detailed file-by-file report from the latest coverage run - `npm run test:coverage:legacy` preserves the older metric for historical comparison -- See `docs/COVERAGE_PLAN.md` for the phased coverage improvement roadmap +- See `docs/ops/COVERAGE_PLAN.md` for the phased coverage improvement roadmap ### Pull Request Requirements @@ -305,7 +305,7 @@ Releases are managed via the `/generate-release` workflow. When a new GitHub Rel ## Getting Help -- **Architecture**: See [`docs/ARCHITECTURE.md`](docs/ARCHITECTURE.md) -- **API Reference**: See [`docs/API_REFERENCE.md`](docs/API_REFERENCE.md) +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](docs/architecture/ARCHITECTURE.md) +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](docs/reference/API_REFERENCE.md) - **Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) - **ADRs**: See `docs/adr/` for architectural decision records diff --git a/docs/i18n/it/README.md b/docs/i18n/it/README.md index 500239cb69..6a6e645ef3 100644 --- a/docs/i18n/it/README.md +++ b/docs/i18n/it/README.md @@ -2267,25 +2267,25 @@ Se não quiser criar credenciais próprias agora, ainda é possível usar o flux ## Documentazione -| Document | Description | -| -------------------------------------------------------- | --------------------------------------------------- | -| [User Guide](docs/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | -| [API Reference](docs/API_REFERENCE.md) | All endpoints with examples | -| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | -| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | -| [Auto-Combo Engine](docs/AUTO-COMBO.md) | 6-factor scoring, mode packs, self-healing | -| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | -| [Troubleshooting](docs/TROUBLESHOOTING.md) | Common problems and solutions | -| [Architecture](docs/ARCHITECTURE.md) | System architecture and internals | -| [Codebase Documentation](docs/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | -| [Uninstall Guide](docs/UNINSTALL.md) | Clean removal for all install methods | -| [Environment Config](docs/ENVIRONMENT.md) | Complete `.env` variables and references | -| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | -| [OpenAPI Spec](docs/openapi.yaml) | OpenAPI 3.0 specification | -| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | -| [VM Deployment](docs/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | -| [Features Gallery](docs/FEATURES.md) | Visual dashboard tour with screenshots | -| [Release Checklist](docs/RELEASE_CHECKLIST.md) | Pre-release validation steps | +| Document | Description | +| --------------------------------------------------------------------- | --------------------------------------------------- | +| [User Guide](docs/guides/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | +| [API Reference](docs/reference/API_REFERENCE.md) | All endpoints with examples | +| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | +| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | +| [Auto-Combo Engine](docs/routing/AUTO-COMBO.md) | 6-factor scoring, mode packs, self-healing | +| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | +| [Troubleshooting](docs/guides/TROUBLESHOOTING.md) | Common problems and solutions | +| [Architecture](docs/architecture/ARCHITECTURE.md) | System architecture and internals | +| [Codebase Documentation](docs/architecture/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | +| [Uninstall Guide](docs/guides/UNINSTALL.md) | Clean removal for all install methods | +| [Environment Config](docs/reference/ENVIRONMENT.md) | Complete `.env` variables and references | +| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | +| [OpenAPI Spec](docs/reference/openapi.yaml) | OpenAPI 3.0 specification | +| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | +| [VM Deployment](docs/ops/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | +| [Features Gallery](docs/guides/FEATURES.md) | Visual dashboard tour with screenshots | +| [Release Checklist](docs/ops/RELEASE_CHECKLIST.md) | Pre-release validation steps | --- diff --git a/docs/i18n/it/docs/ARCHITECTURE.md b/docs/i18n/it/docs/architecture/ARCHITECTURE.md similarity index 100% rename from docs/i18n/it/docs/ARCHITECTURE.md rename to docs/i18n/it/docs/architecture/ARCHITECTURE.md diff --git a/docs/i18n/it/docs/CODEBASE_DOCUMENTATION.md b/docs/i18n/it/docs/architecture/CODEBASE_DOCUMENTATION.md similarity index 100% rename from docs/i18n/it/docs/CODEBASE_DOCUMENTATION.md rename to docs/i18n/it/docs/architecture/CODEBASE_DOCUMENTATION.md diff --git a/docs/i18n/it/docs/A2A-SERVER.md b/docs/i18n/it/docs/frameworks/A2A-SERVER.md similarity index 100% rename from docs/i18n/it/docs/A2A-SERVER.md rename to docs/i18n/it/docs/frameworks/A2A-SERVER.md diff --git a/docs/i18n/it/docs/MCP-SERVER.md b/docs/i18n/it/docs/frameworks/MCP-SERVER.md similarity index 100% rename from docs/i18n/it/docs/MCP-SERVER.md rename to docs/i18n/it/docs/frameworks/MCP-SERVER.md diff --git a/docs/i18n/it/docs/FEATURES.md b/docs/i18n/it/docs/guides/FEATURES.md similarity index 100% rename from docs/i18n/it/docs/FEATURES.md rename to docs/i18n/it/docs/guides/FEATURES.md diff --git a/docs/i18n/it/docs/I18N.md b/docs/i18n/it/docs/guides/I18N.md similarity index 99% rename from docs/i18n/it/docs/I18N.md rename to docs/i18n/it/docs/guides/I18N.md index 3d1a1de63d..7b648f8385 100644 --- a/docs/i18n/it/docs/I18N.md +++ b/docs/i18n/it/docs/guides/I18N.md @@ -420,7 +420,7 @@ The generator originally used `code: "in"` (deprecated Google Translate code) fo ### `docs/i18n/README.md` Is Auto-Generated -The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/I18N.md` (this file) for hand-written documentation that should persist. +The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/guides/I18N.md` (this file) for hand-written documentation that should persist. ### External Untranslatable Keys List diff --git a/docs/i18n/it/docs/TROUBLESHOOTING.md b/docs/i18n/it/docs/guides/TROUBLESHOOTING.md similarity index 98% rename from docs/i18n/it/docs/TROUBLESHOOTING.md rename to docs/i18n/it/docs/guides/TROUBLESHOOTING.md index 8c47be6737..85b2d850ba 100644 --- a/docs/i18n/it/docs/TROUBLESHOOTING.md +++ b/docs/i18n/it/docs/guides/TROUBLESHOOTING.md @@ -335,7 +335,7 @@ You can ignore this section if you do not run RAG or agent pipelines behind Omni ## Still Stuck? - **GitHub Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) -- **Architecture**: See [`docs/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details -- **API Reference**: See [`docs/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints - **Health Dashboard**: Check **Dashboard → Health** for real-time system status - **Translator**: Use **Dashboard → Translator** to debug format issues diff --git a/docs/i18n/it/docs/UNINSTALL.md b/docs/i18n/it/docs/guides/UNINSTALL.md similarity index 100% rename from docs/i18n/it/docs/UNINSTALL.md rename to docs/i18n/it/docs/guides/UNINSTALL.md diff --git a/docs/i18n/it/docs/USER_GUIDE.md b/docs/i18n/it/docs/guides/USER_GUIDE.md similarity index 100% rename from docs/i18n/it/docs/USER_GUIDE.md rename to docs/i18n/it/docs/guides/USER_GUIDE.md diff --git a/docs/i18n/it/docs/COVERAGE_PLAN.md b/docs/i18n/it/docs/ops/COVERAGE_PLAN.md similarity index 100% rename from docs/i18n/it/docs/COVERAGE_PLAN.md rename to docs/i18n/it/docs/ops/COVERAGE_PLAN.md diff --git a/docs/i18n/it/docs/FLY_IO_DEPLOYMENT_GUIDE.md b/docs/i18n/it/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/it/docs/FLY_IO_DEPLOYMENT_GUIDE.md rename to docs/i18n/it/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/it/docs/RELEASE_CHECKLIST.md b/docs/i18n/it/docs/ops/RELEASE_CHECKLIST.md similarity index 94% rename from docs/i18n/it/docs/RELEASE_CHECKLIST.md rename to docs/i18n/it/docs/ops/RELEASE_CHECKLIST.md index d0cc4e3887..45b9e81833 100644 --- a/docs/i18n/it/docs/RELEASE_CHECKLIST.md +++ b/docs/i18n/it/docs/ops/RELEASE_CHECKLIST.md @@ -16,14 +16,14 @@ Use this checklist before tagging or publishing a new OmniRoute release. ## API Docs -1. Update `docs/openapi.yaml`: +1. Update `docs/reference/openapi.yaml`: - `info.version` must equal `package.json` version. 2. Validate endpoint examples if API contracts changed. ## Runtime Docs -1. Review `docs/ARCHITECTURE.md` for storage/runtime drift. -2. Review `docs/TROUBLESHOOTING.md` for env var and operational drift. +1. Review `docs/architecture/ARCHITECTURE.md` for storage/runtime drift. +2. Review `docs/guides/TROUBLESHOOTING.md` for env var and operational drift. 3. Verify the release/runtime Node.js version still satisfies the supported secure floor: - `>=20.20.2 <21` or `>=22.22.2 <23` - `npm run check:node-runtime` diff --git a/docs/i18n/it/docs/VM_DEPLOYMENT_GUIDE.md b/docs/i18n/it/docs/ops/VM_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/it/docs/VM_DEPLOYMENT_GUIDE.md rename to docs/i18n/it/docs/ops/VM_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/it/docs/API_REFERENCE.md b/docs/i18n/it/docs/reference/API_REFERENCE.md similarity index 100% rename from docs/i18n/it/docs/API_REFERENCE.md rename to docs/i18n/it/docs/reference/API_REFERENCE.md diff --git a/docs/i18n/it/docs/CLI-TOOLS.md b/docs/i18n/it/docs/reference/CLI-TOOLS.md similarity index 100% rename from docs/i18n/it/docs/CLI-TOOLS.md rename to docs/i18n/it/docs/reference/CLI-TOOLS.md diff --git a/docs/i18n/it/docs/ENVIRONMENT.md b/docs/i18n/it/docs/reference/ENVIRONMENT.md similarity index 100% rename from docs/i18n/it/docs/ENVIRONMENT.md rename to docs/i18n/it/docs/reference/ENVIRONMENT.md diff --git a/docs/i18n/it/docs/AUTO-COMBO.md b/docs/i18n/it/docs/routing/AUTO-COMBO.md similarity index 100% rename from docs/i18n/it/docs/AUTO-COMBO.md rename to docs/i18n/it/docs/routing/AUTO-COMBO.md diff --git a/docs/i18n/it/llm.txt b/docs/i18n/it/llm.txt index c9bb401e7b..1ec48fb907 100644 --- a/docs/i18n/it/llm.txt +++ b/docs/i18n/it/llm.txt @@ -357,11 +357,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### MCP Server (37 Tools) | Category | Tools | |------------|-------| -| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/MCP-SERVER.md` for full inventory) | +| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/frameworks/MCP-SERVER.md` for full inventory) | | Memory (3) | `memory_search`, `memory_add`, `memory_clear` | | Skills (4) | `skills_list`, `skills_enable`, `skills_execute`, `skills_executions` | -**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/MCP-SERVER.md`. +**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/frameworks/MCP-SERVER.md`. ### Provider Categories @@ -472,7 +472,7 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo 20. **Guardrails framework** in `src/lib/guardrails/` — hot-reloadable registry. Built-ins (priority-ordered): `vision-bridge` (5) → `pii-masker` (10) → `prompt-injection` (20). Fail-open model: exceptions never block traffic. Per-request opt-out via `x-omniroute-disabled-guardrails` header. -21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/AUTHZ_GUIDE.md`. +21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/architecture/AUTHZ_GUIDE.md`. 22. **Three resilience layers** are distinct (do not conflate them): - **Provider Circuit Breaker** (`src/shared/utils/circuitBreaker.ts`) — whole-provider scope. @@ -489,11 +489,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo - **MCP server expanded to 37 tools** (30 base + 3 memory + 4 skills) across ~13 scopes - **OAuth providers expanded to 14**: added Qwen, Kiro, Qoder, Gemini, Windsurf, GitLab Duo - **Coverage gate raised to 75/75/75/70** (was 60% across the board) — measured ~82% -- **Reasoning replay** (`docs/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams +- **Reasoning replay** (`docs/routing/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams - **Compliance + Evals + Webhooks** documentation introduced -- **Stealth guide** (`docs/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration -- **Tunnels guide** (`docs/TUNNELS_GUIDE.md`) — Cloudflare tunnel management -- **Electron guide** (`docs/ELECTRON_GUIDE.md`) — desktop app build + signing +- **Stealth guide** (`docs/security/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration +- **Tunnels guide** (`docs/ops/TUNNELS_GUIDE.md`) — Cloudflare tunnel management +- **Electron guide** (`docs/guides/ELECTRON_GUIDE.md`) — desktop app build + signing ## Links @@ -505,11 +505,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### Documentation Index -- **Architecture & Reference**: `docs/ARCHITECTURE.md`, `docs/CODEBASE_DOCUMENTATION.md`, `docs/REPOSITORY_MAP.md`, `docs/API_REFERENCE.md`, `docs/PROVIDER_REFERENCE.md`, `docs/openapi.yaml` -- **Operator guides**: `docs/USER_GUIDE.md`, `docs/CLI-TOOLS.md`, `docs/TROUBLESHOOTING.md`, `docs/COVERAGE_PLAN.md` -- **Protocols**: `docs/MCP-SERVER.md`, `docs/A2A-SERVER.md`, `docs/AGENT_PROTOCOLS_GUIDE.md`, `docs/CLOUD_AGENT.md` -- **Routing & resilience**: `docs/AUTO-COMBO.md`, `docs/RESILIENCE_GUIDE.md` -- **Security**: `docs/AUTHZ_GUIDE.md`, `docs/GUARDRAILS.md`, `docs/COMPLIANCE.md`, `docs/STEALTH_GUIDE.md` -- **Extensibility**: `docs/SKILLS.md`, `docs/MEMORY.md`, `docs/EVALS.md`, `docs/WEBHOOKS.md`, `docs/REASONING_REPLAY.md` -- **Platform**: `docs/ELECTRON_GUIDE.md`, `docs/TUNNELS_GUIDE.md` +- **Architecture & Reference**: `docs/architecture/ARCHITECTURE.md`, `docs/architecture/CODEBASE_DOCUMENTATION.md`, `docs/architecture/REPOSITORY_MAP.md`, `docs/reference/API_REFERENCE.md`, `docs/reference/PROVIDER_REFERENCE.md`, `docs/reference/openapi.yaml` +- **Operator guides**: `docs/guides/USER_GUIDE.md`, `docs/reference/CLI-TOOLS.md`, `docs/guides/TROUBLESHOOTING.md`, `docs/ops/COVERAGE_PLAN.md` +- **Protocols**: `docs/frameworks/MCP-SERVER.md`, `docs/frameworks/A2A-SERVER.md`, `docs/frameworks/AGENT_PROTOCOLS_GUIDE.md`, `docs/frameworks/CLOUD_AGENT.md` +- **Routing & resilience**: `docs/routing/AUTO-COMBO.md`, `docs/architecture/RESILIENCE_GUIDE.md` +- **Security**: `docs/architecture/AUTHZ_GUIDE.md`, `docs/security/GUARDRAILS.md`, `docs/security/COMPLIANCE.md`, `docs/security/STEALTH_GUIDE.md` +- **Extensibility**: `docs/frameworks/SKILLS.md`, `docs/frameworks/MEMORY.md`, `docs/frameworks/EVALS.md`, `docs/frameworks/WEBHOOKS.md`, `docs/routing/REASONING_REPLAY.md` +- **Platform**: `docs/guides/ELECTRON_GUIDE.md`, `docs/ops/TUNNELS_GUIDE.md` - **AI agents**: `CLAUDE.md`, `AGENTS.md`, `GEMINI.md` diff --git a/docs/i18n/ja/CHANGELOG.md b/docs/i18n/ja/CHANGELOG.md index dec6ed89f1..6a4450202e 100644 --- a/docs/i18n/ja/CHANGELOG.md +++ b/docs/i18n/ja/CHANGELOG.md @@ -1310,7 +1310,7 @@ We identified that **155 community PRs** across the entire project history (from - **33 New API Key Providers:** Massive provider expansion adding DeepInfra, Vercel AI Gateway, Lambda AI, SambaNova, nScale, OVHcloud AI, Baseten, PublicAI, Moonshot AI, Meta Llama API, v0 (Vercel), Morph, Featherless AI, FriendliAI, LlamaGate, Galadriel, Weights & Biases Inference, Volcengine, AI21 Labs, Venice.ai, Codestral, Upstage, Maritalk, Xiaomi MiMo, Inference.net, NanoGPT, Predibase, Bytez, Heroku AI, Databricks, Snowflake Cortex, and GigaChat (Sber). OmniRoute now supports **100+ providers** (4 Free + 8 OAuth + 91 API Key + Custom compatible) - **Global Email Privacy Toggle:** Added a persistent eye-icon toggle button across all dashboard pages (Providers, Usage Limits, Playground) that reveals or hides masked email addresses. Toggle state is stored in localStorage and synced globally via Zustand store - **Documentation Refresh:** Updated README, ARCHITECTURE, FEATURES, AGENTS.md, and API_REFERENCE for v3.6.2 with accurate provider counts (100+), new executor list, and system API documentation -- **Uninstall Guide:** Created comprehensive `docs/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) +- **Uninstall Guide:** Created comprehensive `docs/guides/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) ### 🐛 Bug Fixes diff --git a/docs/i18n/ja/CONTRIBUTING.md b/docs/i18n/ja/CONTRIBUTING.md index 307d2dcb24..6d8f76191e 100644 --- a/docs/i18n/ja/CONTRIBUTING.md +++ b/docs/i18n/ja/CONTRIBUTING.md @@ -153,7 +153,7 @@ Coverage notes: - If a PR changes production code in `src/`, `open-sse/`, `electron/`, or `bin/`, it must add or update automated tests in the same PR - `npm run coverage:report` prints the detailed file-by-file report from the latest coverage run - `npm run test:coverage:legacy` preserves the older metric for historical comparison -- See `docs/COVERAGE_PLAN.md` for the phased coverage improvement roadmap +- See `docs/ops/COVERAGE_PLAN.md` for the phased coverage improvement roadmap ### Pull Request Requirements @@ -305,7 +305,7 @@ Releases are managed via the `/generate-release` workflow. When a new GitHub Rel ## Getting Help -- **Architecture**: See [`docs/ARCHITECTURE.md`](docs/ARCHITECTURE.md) -- **API Reference**: See [`docs/API_REFERENCE.md`](docs/API_REFERENCE.md) +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](docs/architecture/ARCHITECTURE.md) +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](docs/reference/API_REFERENCE.md) - **Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) - **ADRs**: See `docs/adr/` for architectural decision records diff --git a/docs/i18n/ja/README.md b/docs/i18n/ja/README.md index fb03fcd72d..34ee6a7308 100644 --- a/docs/i18n/ja/README.md +++ b/docs/i18n/ja/README.md @@ -2267,25 +2267,25 @@ Se não quiser criar credenciais próprias agora, ainda é possível usar o flux ## ドキュメント -| Document | Description | -| -------------------------------------------------------- | --------------------------------------------------- | -| [User Guide](docs/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | -| [API Reference](docs/API_REFERENCE.md) | All endpoints with examples | -| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | -| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | -| [Auto-Combo Engine](docs/AUTO-COMBO.md) | 6-factor scoring, mode packs, self-healing | -| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | -| [Troubleshooting](docs/TROUBLESHOOTING.md) | Common problems and solutions | -| [Architecture](docs/ARCHITECTURE.md) | System architecture and internals | -| [Codebase Documentation](docs/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | -| [Uninstall Guide](docs/UNINSTALL.md) | Clean removal for all install methods | -| [Environment Config](docs/ENVIRONMENT.md) | Complete `.env` variables and references | -| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | -| [OpenAPI Spec](docs/openapi.yaml) | OpenAPI 3.0 specification | -| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | -| [VM Deployment](docs/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | -| [Features Gallery](docs/FEATURES.md) | Visual dashboard tour with screenshots | -| [Release Checklist](docs/RELEASE_CHECKLIST.md) | Pre-release validation steps | +| Document | Description | +| --------------------------------------------------------------------- | --------------------------------------------------- | +| [User Guide](docs/guides/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | +| [API Reference](docs/reference/API_REFERENCE.md) | All endpoints with examples | +| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | +| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | +| [Auto-Combo Engine](docs/routing/AUTO-COMBO.md) | 6-factor scoring, mode packs, self-healing | +| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | +| [Troubleshooting](docs/guides/TROUBLESHOOTING.md) | Common problems and solutions | +| [Architecture](docs/architecture/ARCHITECTURE.md) | System architecture and internals | +| [Codebase Documentation](docs/architecture/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | +| [Uninstall Guide](docs/guides/UNINSTALL.md) | Clean removal for all install methods | +| [Environment Config](docs/reference/ENVIRONMENT.md) | Complete `.env` variables and references | +| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | +| [OpenAPI Spec](docs/reference/openapi.yaml) | OpenAPI 3.0 specification | +| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | +| [VM Deployment](docs/ops/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | +| [Features Gallery](docs/guides/FEATURES.md) | Visual dashboard tour with screenshots | +| [Release Checklist](docs/ops/RELEASE_CHECKLIST.md) | Pre-release validation steps | --- diff --git a/docs/i18n/ja/docs/ARCHITECTURE.md b/docs/i18n/ja/docs/architecture/ARCHITECTURE.md similarity index 100% rename from docs/i18n/ja/docs/ARCHITECTURE.md rename to docs/i18n/ja/docs/architecture/ARCHITECTURE.md diff --git a/docs/i18n/ja/docs/CODEBASE_DOCUMENTATION.md b/docs/i18n/ja/docs/architecture/CODEBASE_DOCUMENTATION.md similarity index 100% rename from docs/i18n/ja/docs/CODEBASE_DOCUMENTATION.md rename to docs/i18n/ja/docs/architecture/CODEBASE_DOCUMENTATION.md diff --git a/docs/i18n/ja/docs/A2A-SERVER.md b/docs/i18n/ja/docs/frameworks/A2A-SERVER.md similarity index 100% rename from docs/i18n/ja/docs/A2A-SERVER.md rename to docs/i18n/ja/docs/frameworks/A2A-SERVER.md diff --git a/docs/i18n/ja/docs/MCP-SERVER.md b/docs/i18n/ja/docs/frameworks/MCP-SERVER.md similarity index 100% rename from docs/i18n/ja/docs/MCP-SERVER.md rename to docs/i18n/ja/docs/frameworks/MCP-SERVER.md diff --git a/docs/i18n/ja/docs/FEATURES.md b/docs/i18n/ja/docs/guides/FEATURES.md similarity index 100% rename from docs/i18n/ja/docs/FEATURES.md rename to docs/i18n/ja/docs/guides/FEATURES.md diff --git a/docs/i18n/ja/docs/I18N.md b/docs/i18n/ja/docs/guides/I18N.md similarity index 99% rename from docs/i18n/ja/docs/I18N.md rename to docs/i18n/ja/docs/guides/I18N.md index f2c5375bcb..b3c49f1c77 100644 --- a/docs/i18n/ja/docs/I18N.md +++ b/docs/i18n/ja/docs/guides/I18N.md @@ -420,7 +420,7 @@ The generator originally used `code: "in"` (deprecated Google Translate code) fo ### `docs/i18n/README.md` Is Auto-Generated -The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/I18N.md` (this file) for hand-written documentation that should persist. +The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/guides/I18N.md` (this file) for hand-written documentation that should persist. ### External Untranslatable Keys List diff --git a/docs/i18n/ja/docs/TROUBLESHOOTING.md b/docs/i18n/ja/docs/guides/TROUBLESHOOTING.md similarity index 98% rename from docs/i18n/ja/docs/TROUBLESHOOTING.md rename to docs/i18n/ja/docs/guides/TROUBLESHOOTING.md index e2b27bc989..ba7b61683d 100644 --- a/docs/i18n/ja/docs/TROUBLESHOOTING.md +++ b/docs/i18n/ja/docs/guides/TROUBLESHOOTING.md @@ -335,7 +335,7 @@ You can ignore this section if you do not run RAG or agent pipelines behind Omni ## Still Stuck? - **GitHub Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) -- **Architecture**: See [`docs/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details -- **API Reference**: See [`docs/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints - **Health Dashboard**: Check **Dashboard → Health** for real-time system status - **Translator**: Use **Dashboard → Translator** to debug format issues diff --git a/docs/i18n/ja/docs/UNINSTALL.md b/docs/i18n/ja/docs/guides/UNINSTALL.md similarity index 100% rename from docs/i18n/ja/docs/UNINSTALL.md rename to docs/i18n/ja/docs/guides/UNINSTALL.md diff --git a/docs/i18n/ja/docs/USER_GUIDE.md b/docs/i18n/ja/docs/guides/USER_GUIDE.md similarity index 100% rename from docs/i18n/ja/docs/USER_GUIDE.md rename to docs/i18n/ja/docs/guides/USER_GUIDE.md diff --git a/docs/i18n/ja/docs/COVERAGE_PLAN.md b/docs/i18n/ja/docs/ops/COVERAGE_PLAN.md similarity index 100% rename from docs/i18n/ja/docs/COVERAGE_PLAN.md rename to docs/i18n/ja/docs/ops/COVERAGE_PLAN.md diff --git a/docs/i18n/ja/docs/FLY_IO_DEPLOYMENT_GUIDE.md b/docs/i18n/ja/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/ja/docs/FLY_IO_DEPLOYMENT_GUIDE.md rename to docs/i18n/ja/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/ja/docs/RELEASE_CHECKLIST.md b/docs/i18n/ja/docs/ops/RELEASE_CHECKLIST.md similarity index 94% rename from docs/i18n/ja/docs/RELEASE_CHECKLIST.md rename to docs/i18n/ja/docs/ops/RELEASE_CHECKLIST.md index ea7d0f993b..dc46e0a613 100644 --- a/docs/i18n/ja/docs/RELEASE_CHECKLIST.md +++ b/docs/i18n/ja/docs/ops/RELEASE_CHECKLIST.md @@ -16,14 +16,14 @@ Use this checklist before tagging or publishing a new OmniRoute release. ## API Docs -1. Update `docs/openapi.yaml`: +1. Update `docs/reference/openapi.yaml`: - `info.version` must equal `package.json` version. 2. Validate endpoint examples if API contracts changed. ## Runtime Docs -1. Review `docs/ARCHITECTURE.md` for storage/runtime drift. -2. Review `docs/TROUBLESHOOTING.md` for env var and operational drift. +1. Review `docs/architecture/ARCHITECTURE.md` for storage/runtime drift. +2. Review `docs/guides/TROUBLESHOOTING.md` for env var and operational drift. 3. Verify the release/runtime Node.js version still satisfies the supported secure floor: - `>=20.20.2 <21` or `>=22.22.2 <23` - `npm run check:node-runtime` diff --git a/docs/i18n/ja/docs/VM_DEPLOYMENT_GUIDE.md b/docs/i18n/ja/docs/ops/VM_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/ja/docs/VM_DEPLOYMENT_GUIDE.md rename to docs/i18n/ja/docs/ops/VM_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/ja/docs/API_REFERENCE.md b/docs/i18n/ja/docs/reference/API_REFERENCE.md similarity index 100% rename from docs/i18n/ja/docs/API_REFERENCE.md rename to docs/i18n/ja/docs/reference/API_REFERENCE.md diff --git a/docs/i18n/ja/docs/CLI-TOOLS.md b/docs/i18n/ja/docs/reference/CLI-TOOLS.md similarity index 100% rename from docs/i18n/ja/docs/CLI-TOOLS.md rename to docs/i18n/ja/docs/reference/CLI-TOOLS.md diff --git a/docs/i18n/ja/docs/ENVIRONMENT.md b/docs/i18n/ja/docs/reference/ENVIRONMENT.md similarity index 100% rename from docs/i18n/ja/docs/ENVIRONMENT.md rename to docs/i18n/ja/docs/reference/ENVIRONMENT.md diff --git a/docs/i18n/ja/docs/AUTO-COMBO.md b/docs/i18n/ja/docs/routing/AUTO-COMBO.md similarity index 100% rename from docs/i18n/ja/docs/AUTO-COMBO.md rename to docs/i18n/ja/docs/routing/AUTO-COMBO.md diff --git a/docs/i18n/ja/llm.txt b/docs/i18n/ja/llm.txt index 16f03cfc0f..1fd93f3d68 100644 --- a/docs/i18n/ja/llm.txt +++ b/docs/i18n/ja/llm.txt @@ -357,11 +357,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### MCP Server (37 Tools) | Category | Tools | |------------|-------| -| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/MCP-SERVER.md` for full inventory) | +| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/frameworks/MCP-SERVER.md` for full inventory) | | Memory (3) | `memory_search`, `memory_add`, `memory_clear` | | Skills (4) | `skills_list`, `skills_enable`, `skills_execute`, `skills_executions` | -**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/MCP-SERVER.md`. +**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/frameworks/MCP-SERVER.md`. ### Provider Categories @@ -472,7 +472,7 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo 20. **Guardrails framework** in `src/lib/guardrails/` — hot-reloadable registry. Built-ins (priority-ordered): `vision-bridge` (5) → `pii-masker` (10) → `prompt-injection` (20). Fail-open model: exceptions never block traffic. Per-request opt-out via `x-omniroute-disabled-guardrails` header. -21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/AUTHZ_GUIDE.md`. +21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/architecture/AUTHZ_GUIDE.md`. 22. **Three resilience layers** are distinct (do not conflate them): - **Provider Circuit Breaker** (`src/shared/utils/circuitBreaker.ts`) — whole-provider scope. @@ -489,11 +489,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo - **MCP server expanded to 37 tools** (30 base + 3 memory + 4 skills) across ~13 scopes - **OAuth providers expanded to 14**: added Qwen, Kiro, Qoder, Gemini, Windsurf, GitLab Duo - **Coverage gate raised to 75/75/75/70** (was 60% across the board) — measured ~82% -- **Reasoning replay** (`docs/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams +- **Reasoning replay** (`docs/routing/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams - **Compliance + Evals + Webhooks** documentation introduced -- **Stealth guide** (`docs/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration -- **Tunnels guide** (`docs/TUNNELS_GUIDE.md`) — Cloudflare tunnel management -- **Electron guide** (`docs/ELECTRON_GUIDE.md`) — desktop app build + signing +- **Stealth guide** (`docs/security/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration +- **Tunnels guide** (`docs/ops/TUNNELS_GUIDE.md`) — Cloudflare tunnel management +- **Electron guide** (`docs/guides/ELECTRON_GUIDE.md`) — desktop app build + signing ## Links @@ -505,11 +505,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### Documentation Index -- **Architecture & Reference**: `docs/ARCHITECTURE.md`, `docs/CODEBASE_DOCUMENTATION.md`, `docs/REPOSITORY_MAP.md`, `docs/API_REFERENCE.md`, `docs/PROVIDER_REFERENCE.md`, `docs/openapi.yaml` -- **Operator guides**: `docs/USER_GUIDE.md`, `docs/CLI-TOOLS.md`, `docs/TROUBLESHOOTING.md`, `docs/COVERAGE_PLAN.md` -- **Protocols**: `docs/MCP-SERVER.md`, `docs/A2A-SERVER.md`, `docs/AGENT_PROTOCOLS_GUIDE.md`, `docs/CLOUD_AGENT.md` -- **Routing & resilience**: `docs/AUTO-COMBO.md`, `docs/RESILIENCE_GUIDE.md` -- **Security**: `docs/AUTHZ_GUIDE.md`, `docs/GUARDRAILS.md`, `docs/COMPLIANCE.md`, `docs/STEALTH_GUIDE.md` -- **Extensibility**: `docs/SKILLS.md`, `docs/MEMORY.md`, `docs/EVALS.md`, `docs/WEBHOOKS.md`, `docs/REASONING_REPLAY.md` -- **Platform**: `docs/ELECTRON_GUIDE.md`, `docs/TUNNELS_GUIDE.md` +- **Architecture & Reference**: `docs/architecture/ARCHITECTURE.md`, `docs/architecture/CODEBASE_DOCUMENTATION.md`, `docs/architecture/REPOSITORY_MAP.md`, `docs/reference/API_REFERENCE.md`, `docs/reference/PROVIDER_REFERENCE.md`, `docs/reference/openapi.yaml` +- **Operator guides**: `docs/guides/USER_GUIDE.md`, `docs/reference/CLI-TOOLS.md`, `docs/guides/TROUBLESHOOTING.md`, `docs/ops/COVERAGE_PLAN.md` +- **Protocols**: `docs/frameworks/MCP-SERVER.md`, `docs/frameworks/A2A-SERVER.md`, `docs/frameworks/AGENT_PROTOCOLS_GUIDE.md`, `docs/frameworks/CLOUD_AGENT.md` +- **Routing & resilience**: `docs/routing/AUTO-COMBO.md`, `docs/architecture/RESILIENCE_GUIDE.md` +- **Security**: `docs/architecture/AUTHZ_GUIDE.md`, `docs/security/GUARDRAILS.md`, `docs/security/COMPLIANCE.md`, `docs/security/STEALTH_GUIDE.md` +- **Extensibility**: `docs/frameworks/SKILLS.md`, `docs/frameworks/MEMORY.md`, `docs/frameworks/EVALS.md`, `docs/frameworks/WEBHOOKS.md`, `docs/routing/REASONING_REPLAY.md` +- **Platform**: `docs/guides/ELECTRON_GUIDE.md`, `docs/ops/TUNNELS_GUIDE.md` - **AI agents**: `CLAUDE.md`, `AGENTS.md`, `GEMINI.md` diff --git a/docs/i18n/ko/CHANGELOG.md b/docs/i18n/ko/CHANGELOG.md index dc62bdbbd3..5d5dcb3990 100644 --- a/docs/i18n/ko/CHANGELOG.md +++ b/docs/i18n/ko/CHANGELOG.md @@ -1310,7 +1310,7 @@ We identified that **155 community PRs** across the entire project history (from - **33 New API Key Providers:** Massive provider expansion adding DeepInfra, Vercel AI Gateway, Lambda AI, SambaNova, nScale, OVHcloud AI, Baseten, PublicAI, Moonshot AI, Meta Llama API, v0 (Vercel), Morph, Featherless AI, FriendliAI, LlamaGate, Galadriel, Weights & Biases Inference, Volcengine, AI21 Labs, Venice.ai, Codestral, Upstage, Maritalk, Xiaomi MiMo, Inference.net, NanoGPT, Predibase, Bytez, Heroku AI, Databricks, Snowflake Cortex, and GigaChat (Sber). OmniRoute now supports **100+ providers** (4 Free + 8 OAuth + 91 API Key + Custom compatible) - **Global Email Privacy Toggle:** Added a persistent eye-icon toggle button across all dashboard pages (Providers, Usage Limits, Playground) that reveals or hides masked email addresses. Toggle state is stored in localStorage and synced globally via Zustand store - **Documentation Refresh:** Updated README, ARCHITECTURE, FEATURES, AGENTS.md, and API_REFERENCE for v3.6.2 with accurate provider counts (100+), new executor list, and system API documentation -- **Uninstall Guide:** Created comprehensive `docs/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) +- **Uninstall Guide:** Created comprehensive `docs/guides/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) ### 🐛 Bug Fixes diff --git a/docs/i18n/ko/CONTRIBUTING.md b/docs/i18n/ko/CONTRIBUTING.md index d5de24574b..ebe73c8fb3 100644 --- a/docs/i18n/ko/CONTRIBUTING.md +++ b/docs/i18n/ko/CONTRIBUTING.md @@ -153,7 +153,7 @@ Coverage notes: - If a PR changes production code in `src/`, `open-sse/`, `electron/`, or `bin/`, it must add or update automated tests in the same PR - `npm run coverage:report` prints the detailed file-by-file report from the latest coverage run - `npm run test:coverage:legacy` preserves the older metric for historical comparison -- See `docs/COVERAGE_PLAN.md` for the phased coverage improvement roadmap +- See `docs/ops/COVERAGE_PLAN.md` for the phased coverage improvement roadmap ### Pull Request Requirements @@ -305,7 +305,7 @@ Releases are managed via the `/generate-release` workflow. When a new GitHub Rel ## Getting Help -- **Architecture**: See [`docs/ARCHITECTURE.md`](docs/ARCHITECTURE.md) -- **API Reference**: See [`docs/API_REFERENCE.md`](docs/API_REFERENCE.md) +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](docs/architecture/ARCHITECTURE.md) +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](docs/reference/API_REFERENCE.md) - **Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) - **ADRs**: See `docs/adr/` for architectural decision records diff --git a/docs/i18n/ko/README.md b/docs/i18n/ko/README.md index ffe4cd20fd..63e601edc6 100644 --- a/docs/i18n/ko/README.md +++ b/docs/i18n/ko/README.md @@ -2267,25 +2267,25 @@ Se não quiser criar credenciais próprias agora, ainda é possível usar o flux ## 문서 -| Document | Description | -| -------------------------------------------------------- | --------------------------------------------------- | -| [User Guide](docs/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | -| [API Reference](docs/API_REFERENCE.md) | All endpoints with examples | -| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | -| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | -| [Auto-Combo Engine](docs/AUTO-COMBO.md) | 6-factor scoring, mode packs, self-healing | -| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | -| [Troubleshooting](docs/TROUBLESHOOTING.md) | Common problems and solutions | -| [Architecture](docs/ARCHITECTURE.md) | System architecture and internals | -| [Codebase Documentation](docs/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | -| [Uninstall Guide](docs/UNINSTALL.md) | Clean removal for all install methods | -| [Environment Config](docs/ENVIRONMENT.md) | Complete `.env` variables and references | -| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | -| [OpenAPI Spec](docs/openapi.yaml) | OpenAPI 3.0 specification | -| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | -| [VM Deployment](docs/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | -| [Features Gallery](docs/FEATURES.md) | Visual dashboard tour with screenshots | -| [Release Checklist](docs/RELEASE_CHECKLIST.md) | Pre-release validation steps | +| Document | Description | +| --------------------------------------------------------------------- | --------------------------------------------------- | +| [User Guide](docs/guides/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | +| [API Reference](docs/reference/API_REFERENCE.md) | All endpoints with examples | +| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | +| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | +| [Auto-Combo Engine](docs/routing/AUTO-COMBO.md) | 6-factor scoring, mode packs, self-healing | +| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | +| [Troubleshooting](docs/guides/TROUBLESHOOTING.md) | Common problems and solutions | +| [Architecture](docs/architecture/ARCHITECTURE.md) | System architecture and internals | +| [Codebase Documentation](docs/architecture/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | +| [Uninstall Guide](docs/guides/UNINSTALL.md) | Clean removal for all install methods | +| [Environment Config](docs/reference/ENVIRONMENT.md) | Complete `.env` variables and references | +| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | +| [OpenAPI Spec](docs/reference/openapi.yaml) | OpenAPI 3.0 specification | +| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | +| [VM Deployment](docs/ops/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | +| [Features Gallery](docs/guides/FEATURES.md) | Visual dashboard tour with screenshots | +| [Release Checklist](docs/ops/RELEASE_CHECKLIST.md) | Pre-release validation steps | --- diff --git a/docs/i18n/ko/docs/ARCHITECTURE.md b/docs/i18n/ko/docs/architecture/ARCHITECTURE.md similarity index 100% rename from docs/i18n/ko/docs/ARCHITECTURE.md rename to docs/i18n/ko/docs/architecture/ARCHITECTURE.md diff --git a/docs/i18n/ko/docs/CODEBASE_DOCUMENTATION.md b/docs/i18n/ko/docs/architecture/CODEBASE_DOCUMENTATION.md similarity index 100% rename from docs/i18n/ko/docs/CODEBASE_DOCUMENTATION.md rename to docs/i18n/ko/docs/architecture/CODEBASE_DOCUMENTATION.md diff --git a/docs/i18n/ko/docs/A2A-SERVER.md b/docs/i18n/ko/docs/frameworks/A2A-SERVER.md similarity index 100% rename from docs/i18n/ko/docs/A2A-SERVER.md rename to docs/i18n/ko/docs/frameworks/A2A-SERVER.md diff --git a/docs/i18n/ko/docs/MCP-SERVER.md b/docs/i18n/ko/docs/frameworks/MCP-SERVER.md similarity index 100% rename from docs/i18n/ko/docs/MCP-SERVER.md rename to docs/i18n/ko/docs/frameworks/MCP-SERVER.md diff --git a/docs/i18n/ko/docs/FEATURES.md b/docs/i18n/ko/docs/guides/FEATURES.md similarity index 100% rename from docs/i18n/ko/docs/FEATURES.md rename to docs/i18n/ko/docs/guides/FEATURES.md diff --git a/docs/i18n/ko/docs/I18N.md b/docs/i18n/ko/docs/guides/I18N.md similarity index 99% rename from docs/i18n/ko/docs/I18N.md rename to docs/i18n/ko/docs/guides/I18N.md index af5e4fd0bb..fea5b6e87b 100644 --- a/docs/i18n/ko/docs/I18N.md +++ b/docs/i18n/ko/docs/guides/I18N.md @@ -420,7 +420,7 @@ The generator originally used `code: "in"` (deprecated Google Translate code) fo ### `docs/i18n/README.md` Is Auto-Generated -The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/I18N.md` (this file) for hand-written documentation that should persist. +The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/guides/I18N.md` (this file) for hand-written documentation that should persist. ### External Untranslatable Keys List diff --git a/docs/i18n/ko/docs/TROUBLESHOOTING.md b/docs/i18n/ko/docs/guides/TROUBLESHOOTING.md similarity index 98% rename from docs/i18n/ko/docs/TROUBLESHOOTING.md rename to docs/i18n/ko/docs/guides/TROUBLESHOOTING.md index 245f52fdb2..5e5fcfe9ae 100644 --- a/docs/i18n/ko/docs/TROUBLESHOOTING.md +++ b/docs/i18n/ko/docs/guides/TROUBLESHOOTING.md @@ -335,7 +335,7 @@ You can ignore this section if you do not run RAG or agent pipelines behind Omni ## Still Stuck? - **GitHub Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) -- **Architecture**: See [`docs/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details -- **API Reference**: See [`docs/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints - **Health Dashboard**: Check **Dashboard → Health** for real-time system status - **Translator**: Use **Dashboard → Translator** to debug format issues diff --git a/docs/i18n/ko/docs/UNINSTALL.md b/docs/i18n/ko/docs/guides/UNINSTALL.md similarity index 100% rename from docs/i18n/ko/docs/UNINSTALL.md rename to docs/i18n/ko/docs/guides/UNINSTALL.md diff --git a/docs/i18n/ko/docs/USER_GUIDE.md b/docs/i18n/ko/docs/guides/USER_GUIDE.md similarity index 100% rename from docs/i18n/ko/docs/USER_GUIDE.md rename to docs/i18n/ko/docs/guides/USER_GUIDE.md diff --git a/docs/i18n/ko/docs/COVERAGE_PLAN.md b/docs/i18n/ko/docs/ops/COVERAGE_PLAN.md similarity index 100% rename from docs/i18n/ko/docs/COVERAGE_PLAN.md rename to docs/i18n/ko/docs/ops/COVERAGE_PLAN.md diff --git a/docs/i18n/ko/docs/FLY_IO_DEPLOYMENT_GUIDE.md b/docs/i18n/ko/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/ko/docs/FLY_IO_DEPLOYMENT_GUIDE.md rename to docs/i18n/ko/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/ko/docs/RELEASE_CHECKLIST.md b/docs/i18n/ko/docs/ops/RELEASE_CHECKLIST.md similarity index 94% rename from docs/i18n/ko/docs/RELEASE_CHECKLIST.md rename to docs/i18n/ko/docs/ops/RELEASE_CHECKLIST.md index dbfe24caa9..f2d95b262e 100644 --- a/docs/i18n/ko/docs/RELEASE_CHECKLIST.md +++ b/docs/i18n/ko/docs/ops/RELEASE_CHECKLIST.md @@ -16,14 +16,14 @@ Use this checklist before tagging or publishing a new OmniRoute release. ## API Docs -1. Update `docs/openapi.yaml`: +1. Update `docs/reference/openapi.yaml`: - `info.version` must equal `package.json` version. 2. Validate endpoint examples if API contracts changed. ## Runtime Docs -1. Review `docs/ARCHITECTURE.md` for storage/runtime drift. -2. Review `docs/TROUBLESHOOTING.md` for env var and operational drift. +1. Review `docs/architecture/ARCHITECTURE.md` for storage/runtime drift. +2. Review `docs/guides/TROUBLESHOOTING.md` for env var and operational drift. 3. Verify the release/runtime Node.js version still satisfies the supported secure floor: - `>=20.20.2 <21` or `>=22.22.2 <23` - `npm run check:node-runtime` diff --git a/docs/i18n/ko/docs/VM_DEPLOYMENT_GUIDE.md b/docs/i18n/ko/docs/ops/VM_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/ko/docs/VM_DEPLOYMENT_GUIDE.md rename to docs/i18n/ko/docs/ops/VM_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/ko/docs/API_REFERENCE.md b/docs/i18n/ko/docs/reference/API_REFERENCE.md similarity index 100% rename from docs/i18n/ko/docs/API_REFERENCE.md rename to docs/i18n/ko/docs/reference/API_REFERENCE.md diff --git a/docs/i18n/ko/docs/CLI-TOOLS.md b/docs/i18n/ko/docs/reference/CLI-TOOLS.md similarity index 100% rename from docs/i18n/ko/docs/CLI-TOOLS.md rename to docs/i18n/ko/docs/reference/CLI-TOOLS.md diff --git a/docs/i18n/ko/docs/ENVIRONMENT.md b/docs/i18n/ko/docs/reference/ENVIRONMENT.md similarity index 100% rename from docs/i18n/ko/docs/ENVIRONMENT.md rename to docs/i18n/ko/docs/reference/ENVIRONMENT.md diff --git a/docs/i18n/ko/docs/AUTO-COMBO.md b/docs/i18n/ko/docs/routing/AUTO-COMBO.md similarity index 100% rename from docs/i18n/ko/docs/AUTO-COMBO.md rename to docs/i18n/ko/docs/routing/AUTO-COMBO.md diff --git a/docs/i18n/ko/llm.txt b/docs/i18n/ko/llm.txt index f0315b1d54..1a20747f59 100644 --- a/docs/i18n/ko/llm.txt +++ b/docs/i18n/ko/llm.txt @@ -357,11 +357,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### MCP Server (37 Tools) | Category | Tools | |------------|-------| -| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/MCP-SERVER.md` for full inventory) | +| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/frameworks/MCP-SERVER.md` for full inventory) | | Memory (3) | `memory_search`, `memory_add`, `memory_clear` | | Skills (4) | `skills_list`, `skills_enable`, `skills_execute`, `skills_executions` | -**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/MCP-SERVER.md`. +**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/frameworks/MCP-SERVER.md`. ### Provider Categories @@ -472,7 +472,7 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo 20. **Guardrails framework** in `src/lib/guardrails/` — hot-reloadable registry. Built-ins (priority-ordered): `vision-bridge` (5) → `pii-masker` (10) → `prompt-injection` (20). Fail-open model: exceptions never block traffic. Per-request opt-out via `x-omniroute-disabled-guardrails` header. -21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/AUTHZ_GUIDE.md`. +21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/architecture/AUTHZ_GUIDE.md`. 22. **Three resilience layers** are distinct (do not conflate them): - **Provider Circuit Breaker** (`src/shared/utils/circuitBreaker.ts`) — whole-provider scope. @@ -489,11 +489,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo - **MCP server expanded to 37 tools** (30 base + 3 memory + 4 skills) across ~13 scopes - **OAuth providers expanded to 14**: added Qwen, Kiro, Qoder, Gemini, Windsurf, GitLab Duo - **Coverage gate raised to 75/75/75/70** (was 60% across the board) — measured ~82% -- **Reasoning replay** (`docs/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams +- **Reasoning replay** (`docs/routing/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams - **Compliance + Evals + Webhooks** documentation introduced -- **Stealth guide** (`docs/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration -- **Tunnels guide** (`docs/TUNNELS_GUIDE.md`) — Cloudflare tunnel management -- **Electron guide** (`docs/ELECTRON_GUIDE.md`) — desktop app build + signing +- **Stealth guide** (`docs/security/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration +- **Tunnels guide** (`docs/ops/TUNNELS_GUIDE.md`) — Cloudflare tunnel management +- **Electron guide** (`docs/guides/ELECTRON_GUIDE.md`) — desktop app build + signing ## Links @@ -505,11 +505,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### Documentation Index -- **Architecture & Reference**: `docs/ARCHITECTURE.md`, `docs/CODEBASE_DOCUMENTATION.md`, `docs/REPOSITORY_MAP.md`, `docs/API_REFERENCE.md`, `docs/PROVIDER_REFERENCE.md`, `docs/openapi.yaml` -- **Operator guides**: `docs/USER_GUIDE.md`, `docs/CLI-TOOLS.md`, `docs/TROUBLESHOOTING.md`, `docs/COVERAGE_PLAN.md` -- **Protocols**: `docs/MCP-SERVER.md`, `docs/A2A-SERVER.md`, `docs/AGENT_PROTOCOLS_GUIDE.md`, `docs/CLOUD_AGENT.md` -- **Routing & resilience**: `docs/AUTO-COMBO.md`, `docs/RESILIENCE_GUIDE.md` -- **Security**: `docs/AUTHZ_GUIDE.md`, `docs/GUARDRAILS.md`, `docs/COMPLIANCE.md`, `docs/STEALTH_GUIDE.md` -- **Extensibility**: `docs/SKILLS.md`, `docs/MEMORY.md`, `docs/EVALS.md`, `docs/WEBHOOKS.md`, `docs/REASONING_REPLAY.md` -- **Platform**: `docs/ELECTRON_GUIDE.md`, `docs/TUNNELS_GUIDE.md` +- **Architecture & Reference**: `docs/architecture/ARCHITECTURE.md`, `docs/architecture/CODEBASE_DOCUMENTATION.md`, `docs/architecture/REPOSITORY_MAP.md`, `docs/reference/API_REFERENCE.md`, `docs/reference/PROVIDER_REFERENCE.md`, `docs/reference/openapi.yaml` +- **Operator guides**: `docs/guides/USER_GUIDE.md`, `docs/reference/CLI-TOOLS.md`, `docs/guides/TROUBLESHOOTING.md`, `docs/ops/COVERAGE_PLAN.md` +- **Protocols**: `docs/frameworks/MCP-SERVER.md`, `docs/frameworks/A2A-SERVER.md`, `docs/frameworks/AGENT_PROTOCOLS_GUIDE.md`, `docs/frameworks/CLOUD_AGENT.md` +- **Routing & resilience**: `docs/routing/AUTO-COMBO.md`, `docs/architecture/RESILIENCE_GUIDE.md` +- **Security**: `docs/architecture/AUTHZ_GUIDE.md`, `docs/security/GUARDRAILS.md`, `docs/security/COMPLIANCE.md`, `docs/security/STEALTH_GUIDE.md` +- **Extensibility**: `docs/frameworks/SKILLS.md`, `docs/frameworks/MEMORY.md`, `docs/frameworks/EVALS.md`, `docs/frameworks/WEBHOOKS.md`, `docs/routing/REASONING_REPLAY.md` +- **Platform**: `docs/guides/ELECTRON_GUIDE.md`, `docs/ops/TUNNELS_GUIDE.md` - **AI agents**: `CLAUDE.md`, `AGENTS.md`, `GEMINI.md` diff --git a/docs/i18n/mr/CHANGELOG.md b/docs/i18n/mr/CHANGELOG.md index 29f28182c6..0fb797a8b4 100644 --- a/docs/i18n/mr/CHANGELOG.md +++ b/docs/i18n/mr/CHANGELOG.md @@ -1310,7 +1310,7 @@ We identified that **155 community PRs** across the entire project history (from - **33 New API Key Providers:** Massive provider expansion adding DeepInfra, Vercel AI Gateway, Lambda AI, SambaNova, nScale, OVHcloud AI, Baseten, PublicAI, Moonshot AI, Meta Llama API, v0 (Vercel), Morph, Featherless AI, FriendliAI, LlamaGate, Galadriel, Weights & Biases Inference, Volcengine, AI21 Labs, Venice.ai, Codestral, Upstage, Maritalk, Xiaomi MiMo, Inference.net, NanoGPT, Predibase, Bytez, Heroku AI, Databricks, Snowflake Cortex, and GigaChat (Sber). OmniRoute now supports **100+ providers** (4 Free + 8 OAuth + 91 API Key + Custom compatible) - **Global Email Privacy Toggle:** Added a persistent eye-icon toggle button across all dashboard pages (Providers, Usage Limits, Playground) that reveals or hides masked email addresses. Toggle state is stored in localStorage and synced globally via Zustand store - **Documentation Refresh:** Updated README, ARCHITECTURE, FEATURES, AGENTS.md, and API_REFERENCE for v3.6.2 with accurate provider counts (100+), new executor list, and system API documentation -- **Uninstall Guide:** Created comprehensive `docs/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) +- **Uninstall Guide:** Created comprehensive `docs/guides/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) ### 🐛 Bug Fixes diff --git a/docs/i18n/mr/CONTRIBUTING.md b/docs/i18n/mr/CONTRIBUTING.md index a4dedc4578..2245c3f831 100644 --- a/docs/i18n/mr/CONTRIBUTING.md +++ b/docs/i18n/mr/CONTRIBUTING.md @@ -153,7 +153,7 @@ Coverage notes: - If a PR changes production code in `src/`, `open-sse/`, `electron/`, or `bin/`, it must add or update automated tests in the same PR - `npm run coverage:report` prints the detailed file-by-file report from the latest coverage run - `npm run test:coverage:legacy` preserves the older metric for historical comparison -- See `docs/COVERAGE_PLAN.md` for the phased coverage improvement roadmap +- See `docs/ops/COVERAGE_PLAN.md` for the phased coverage improvement roadmap ### Pull Request Requirements @@ -305,7 +305,7 @@ Releases are managed via the `/generate-release` workflow. When a new GitHub Rel ## Getting Help -- **Architecture**: See [`docs/ARCHITECTURE.md`](docs/ARCHITECTURE.md) -- **API Reference**: See [`docs/API_REFERENCE.md`](docs/API_REFERENCE.md) +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](docs/architecture/ARCHITECTURE.md) +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](docs/reference/API_REFERENCE.md) - **Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) - **ADRs**: See `docs/adr/` for architectural decision records diff --git a/docs/i18n/mr/README.md b/docs/i18n/mr/README.md index 57ec532cab..cda2a91b5c 100644 --- a/docs/i18n/mr/README.md +++ b/docs/i18n/mr/README.md @@ -2267,25 +2267,25 @@ Se não quiser criar credenciais próprias agora, ainda é possível usar o flux ## Documentación -| Document | Description | -| -------------------------------------------------------- | --------------------------------------------------- | -| [User Guide](docs/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | -| [API Reference](docs/API_REFERENCE.md) | All endpoints with examples | -| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | -| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | -| [Auto-Combo Engine](docs/auto-combo.md) | 6-factor scoring, mode packs, self-healing | -| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | -| [Troubleshooting](docs/TROUBLESHOOTING.md) | Common problems and solutions | -| [Architecture](docs/ARCHITECTURE.md) | System architecture and internals | -| [Codebase Documentation](docs/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | -| [Uninstall Guide](docs/UNINSTALL.md) | Clean removal for all install methods | -| [Environment Config](docs/ENVIRONMENT.md) | Complete `.env` variables and references | -| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | -| [OpenAPI Spec](docs/openapi.yaml) | OpenAPI 3.0 specification | -| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | -| [VM Deployment](docs/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | -| [Features Gallery](docs/FEATURES.md) | Visual dashboard tour with screenshots | -| [Release Checklist](docs/RELEASE_CHECKLIST.md) | Pre-release validation steps | +| Document | Description | +| --------------------------------------------------------------------- | --------------------------------------------------- | +| [User Guide](docs/guides/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | +| [API Reference](docs/reference/API_REFERENCE.md) | All endpoints with examples | +| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | +| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | +| [Auto-Combo Engine](docs/auto-combo.md) | 6-factor scoring, mode packs, self-healing | +| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | +| [Troubleshooting](docs/guides/TROUBLESHOOTING.md) | Common problems and solutions | +| [Architecture](docs/architecture/ARCHITECTURE.md) | System architecture and internals | +| [Codebase Documentation](docs/architecture/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | +| [Uninstall Guide](docs/guides/UNINSTALL.md) | Clean removal for all install methods | +| [Environment Config](docs/reference/ENVIRONMENT.md) | Complete `.env` variables and references | +| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | +| [OpenAPI Spec](docs/reference/openapi.yaml) | OpenAPI 3.0 specification | +| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | +| [VM Deployment](docs/ops/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | +| [Features Gallery](docs/guides/FEATURES.md) | Visual dashboard tour with screenshots | +| [Release Checklist](docs/ops/RELEASE_CHECKLIST.md) | Pre-release validation steps | --- diff --git a/docs/i18n/mr/docs/ARCHITECTURE.md b/docs/i18n/mr/docs/architecture/ARCHITECTURE.md similarity index 100% rename from docs/i18n/mr/docs/ARCHITECTURE.md rename to docs/i18n/mr/docs/architecture/ARCHITECTURE.md diff --git a/docs/i18n/mr/docs/CODEBASE_DOCUMENTATION.md b/docs/i18n/mr/docs/architecture/CODEBASE_DOCUMENTATION.md similarity index 100% rename from docs/i18n/mr/docs/CODEBASE_DOCUMENTATION.md rename to docs/i18n/mr/docs/architecture/CODEBASE_DOCUMENTATION.md diff --git a/docs/i18n/mr/docs/A2A-SERVER.md b/docs/i18n/mr/docs/frameworks/A2A-SERVER.md similarity index 100% rename from docs/i18n/mr/docs/A2A-SERVER.md rename to docs/i18n/mr/docs/frameworks/A2A-SERVER.md diff --git a/docs/i18n/mr/docs/MCP-SERVER.md b/docs/i18n/mr/docs/frameworks/MCP-SERVER.md similarity index 100% rename from docs/i18n/mr/docs/MCP-SERVER.md rename to docs/i18n/mr/docs/frameworks/MCP-SERVER.md diff --git a/docs/i18n/mr/docs/FEATURES.md b/docs/i18n/mr/docs/guides/FEATURES.md similarity index 100% rename from docs/i18n/mr/docs/FEATURES.md rename to docs/i18n/mr/docs/guides/FEATURES.md diff --git a/docs/i18n/mr/docs/I18N.md b/docs/i18n/mr/docs/guides/I18N.md similarity index 99% rename from docs/i18n/mr/docs/I18N.md rename to docs/i18n/mr/docs/guides/I18N.md index a1c23e03e7..1604a3fbcf 100644 --- a/docs/i18n/mr/docs/I18N.md +++ b/docs/i18n/mr/docs/guides/I18N.md @@ -420,7 +420,7 @@ The generator originally used `code: "in"` (deprecated Google Translate code) fo ### `docs/i18n/README.md` Is Auto-Generated -The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/I18N.md` (this file) for hand-written documentation that should persist. +The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/guides/I18N.md` (this file) for hand-written documentation that should persist. ### External Untranslatable Keys List diff --git a/docs/i18n/mr/docs/TROUBLESHOOTING.md b/docs/i18n/mr/docs/guides/TROUBLESHOOTING.md similarity index 98% rename from docs/i18n/mr/docs/TROUBLESHOOTING.md rename to docs/i18n/mr/docs/guides/TROUBLESHOOTING.md index 18bfb5a393..42b85cd959 100644 --- a/docs/i18n/mr/docs/TROUBLESHOOTING.md +++ b/docs/i18n/mr/docs/guides/TROUBLESHOOTING.md @@ -335,7 +335,7 @@ You can ignore this section if you do not run RAG or agent pipelines behind Omni ## Still Stuck? - **GitHub Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) -- **Architecture**: See [`docs/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details -- **API Reference**: See [`docs/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints - **Health Dashboard**: Check **Dashboard → Health** for real-time system status - **Translator**: Use **Dashboard → Translator** to debug format issues diff --git a/docs/i18n/mr/docs/UNINSTALL.md b/docs/i18n/mr/docs/guides/UNINSTALL.md similarity index 100% rename from docs/i18n/mr/docs/UNINSTALL.md rename to docs/i18n/mr/docs/guides/UNINSTALL.md diff --git a/docs/i18n/mr/docs/USER_GUIDE.md b/docs/i18n/mr/docs/guides/USER_GUIDE.md similarity index 100% rename from docs/i18n/mr/docs/USER_GUIDE.md rename to docs/i18n/mr/docs/guides/USER_GUIDE.md diff --git a/docs/i18n/mr/docs/COVERAGE_PLAN.md b/docs/i18n/mr/docs/ops/COVERAGE_PLAN.md similarity index 100% rename from docs/i18n/mr/docs/COVERAGE_PLAN.md rename to docs/i18n/mr/docs/ops/COVERAGE_PLAN.md diff --git a/docs/i18n/mr/docs/FLY_IO_DEPLOYMENT_GUIDE.md b/docs/i18n/mr/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/mr/docs/FLY_IO_DEPLOYMENT_GUIDE.md rename to docs/i18n/mr/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/mr/docs/RELEASE_CHECKLIST.md b/docs/i18n/mr/docs/ops/RELEASE_CHECKLIST.md similarity index 94% rename from docs/i18n/mr/docs/RELEASE_CHECKLIST.md rename to docs/i18n/mr/docs/ops/RELEASE_CHECKLIST.md index 7ec2d34f16..5028558782 100644 --- a/docs/i18n/mr/docs/RELEASE_CHECKLIST.md +++ b/docs/i18n/mr/docs/ops/RELEASE_CHECKLIST.md @@ -16,14 +16,14 @@ Use this checklist before tagging or publishing a new OmniRoute release. ## API Docs -1. Update `docs/openapi.yaml`: +1. Update `docs/reference/openapi.yaml`: - `info.version` must equal `package.json` version. 2. Validate endpoint examples if API contracts changed. ## Runtime Docs -1. Review `docs/ARCHITECTURE.md` for storage/runtime drift. -2. Review `docs/TROUBLESHOOTING.md` for env var and operational drift. +1. Review `docs/architecture/ARCHITECTURE.md` for storage/runtime drift. +2. Review `docs/guides/TROUBLESHOOTING.md` for env var and operational drift. 3. Verify the release/runtime Node.js version still satisfies the supported secure floor: - `>=20.20.2 <21` or `>=22.22.2 <23` - `npm run check:node-runtime` diff --git a/docs/i18n/mr/docs/VM_DEPLOYMENT_GUIDE.md b/docs/i18n/mr/docs/ops/VM_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/mr/docs/VM_DEPLOYMENT_GUIDE.md rename to docs/i18n/mr/docs/ops/VM_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/mr/docs/API_REFERENCE.md b/docs/i18n/mr/docs/reference/API_REFERENCE.md similarity index 100% rename from docs/i18n/mr/docs/API_REFERENCE.md rename to docs/i18n/mr/docs/reference/API_REFERENCE.md diff --git a/docs/i18n/mr/docs/CLI-TOOLS.md b/docs/i18n/mr/docs/reference/CLI-TOOLS.md similarity index 100% rename from docs/i18n/mr/docs/CLI-TOOLS.md rename to docs/i18n/mr/docs/reference/CLI-TOOLS.md diff --git a/docs/i18n/mr/docs/ENVIRONMENT.md b/docs/i18n/mr/docs/reference/ENVIRONMENT.md similarity index 100% rename from docs/i18n/mr/docs/ENVIRONMENT.md rename to docs/i18n/mr/docs/reference/ENVIRONMENT.md diff --git a/docs/i18n/mr/docs/AUTO-COMBO.md b/docs/i18n/mr/docs/routing/AUTO-COMBO.md similarity index 100% rename from docs/i18n/mr/docs/AUTO-COMBO.md rename to docs/i18n/mr/docs/routing/AUTO-COMBO.md diff --git a/docs/i18n/mr/llm.txt b/docs/i18n/mr/llm.txt index 2d4b0c2b8f..be205b03e8 100644 --- a/docs/i18n/mr/llm.txt +++ b/docs/i18n/mr/llm.txt @@ -357,11 +357,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### MCP Server (37 Tools) | Category | Tools | |------------|-------| -| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/MCP-SERVER.md` for full inventory) | +| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/frameworks/MCP-SERVER.md` for full inventory) | | Memory (3) | `memory_search`, `memory_add`, `memory_clear` | | Skills (4) | `skills_list`, `skills_enable`, `skills_execute`, `skills_executions` | -**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/MCP-SERVER.md`. +**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/frameworks/MCP-SERVER.md`. ### Provider Categories @@ -472,7 +472,7 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo 20. **Guardrails framework** in `src/lib/guardrails/` — hot-reloadable registry. Built-ins (priority-ordered): `vision-bridge` (5) → `pii-masker` (10) → `prompt-injection` (20). Fail-open model: exceptions never block traffic. Per-request opt-out via `x-omniroute-disabled-guardrails` header. -21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/AUTHZ_GUIDE.md`. +21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/architecture/AUTHZ_GUIDE.md`. 22. **Three resilience layers** are distinct (do not conflate them): - **Provider Circuit Breaker** (`src/shared/utils/circuitBreaker.ts`) — whole-provider scope. @@ -489,11 +489,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo - **MCP server expanded to 37 tools** (30 base + 3 memory + 4 skills) across ~13 scopes - **OAuth providers expanded to 14**: added Qwen, Kiro, Qoder, Gemini, Windsurf, GitLab Duo - **Coverage gate raised to 75/75/75/70** (was 60% across the board) — measured ~82% -- **Reasoning replay** (`docs/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams +- **Reasoning replay** (`docs/routing/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams - **Compliance + Evals + Webhooks** documentation introduced -- **Stealth guide** (`docs/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration -- **Tunnels guide** (`docs/TUNNELS_GUIDE.md`) — Cloudflare tunnel management -- **Electron guide** (`docs/ELECTRON_GUIDE.md`) — desktop app build + signing +- **Stealth guide** (`docs/security/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration +- **Tunnels guide** (`docs/ops/TUNNELS_GUIDE.md`) — Cloudflare tunnel management +- **Electron guide** (`docs/guides/ELECTRON_GUIDE.md`) — desktop app build + signing ## Links @@ -505,11 +505,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### Documentation Index -- **Architecture & Reference**: `docs/ARCHITECTURE.md`, `docs/CODEBASE_DOCUMENTATION.md`, `docs/REPOSITORY_MAP.md`, `docs/API_REFERENCE.md`, `docs/PROVIDER_REFERENCE.md`, `docs/openapi.yaml` -- **Operator guides**: `docs/USER_GUIDE.md`, `docs/CLI-TOOLS.md`, `docs/TROUBLESHOOTING.md`, `docs/COVERAGE_PLAN.md` -- **Protocols**: `docs/MCP-SERVER.md`, `docs/A2A-SERVER.md`, `docs/AGENT_PROTOCOLS_GUIDE.md`, `docs/CLOUD_AGENT.md` -- **Routing & resilience**: `docs/AUTO-COMBO.md`, `docs/RESILIENCE_GUIDE.md` -- **Security**: `docs/AUTHZ_GUIDE.md`, `docs/GUARDRAILS.md`, `docs/COMPLIANCE.md`, `docs/STEALTH_GUIDE.md` -- **Extensibility**: `docs/SKILLS.md`, `docs/MEMORY.md`, `docs/EVALS.md`, `docs/WEBHOOKS.md`, `docs/REASONING_REPLAY.md` -- **Platform**: `docs/ELECTRON_GUIDE.md`, `docs/TUNNELS_GUIDE.md` +- **Architecture & Reference**: `docs/architecture/ARCHITECTURE.md`, `docs/architecture/CODEBASE_DOCUMENTATION.md`, `docs/architecture/REPOSITORY_MAP.md`, `docs/reference/API_REFERENCE.md`, `docs/reference/PROVIDER_REFERENCE.md`, `docs/reference/openapi.yaml` +- **Operator guides**: `docs/guides/USER_GUIDE.md`, `docs/reference/CLI-TOOLS.md`, `docs/guides/TROUBLESHOOTING.md`, `docs/ops/COVERAGE_PLAN.md` +- **Protocols**: `docs/frameworks/MCP-SERVER.md`, `docs/frameworks/A2A-SERVER.md`, `docs/frameworks/AGENT_PROTOCOLS_GUIDE.md`, `docs/frameworks/CLOUD_AGENT.md` +- **Routing & resilience**: `docs/routing/AUTO-COMBO.md`, `docs/architecture/RESILIENCE_GUIDE.md` +- **Security**: `docs/architecture/AUTHZ_GUIDE.md`, `docs/security/GUARDRAILS.md`, `docs/security/COMPLIANCE.md`, `docs/security/STEALTH_GUIDE.md` +- **Extensibility**: `docs/frameworks/SKILLS.md`, `docs/frameworks/MEMORY.md`, `docs/frameworks/EVALS.md`, `docs/frameworks/WEBHOOKS.md`, `docs/routing/REASONING_REPLAY.md` +- **Platform**: `docs/guides/ELECTRON_GUIDE.md`, `docs/ops/TUNNELS_GUIDE.md` - **AI agents**: `CLAUDE.md`, `AGENTS.md`, `GEMINI.md` diff --git a/docs/i18n/ms/CHANGELOG.md b/docs/i18n/ms/CHANGELOG.md index 19807106c2..0a7b677bad 100644 --- a/docs/i18n/ms/CHANGELOG.md +++ b/docs/i18n/ms/CHANGELOG.md @@ -1310,7 +1310,7 @@ We identified that **155 community PRs** across the entire project history (from - **33 New API Key Providers:** Massive provider expansion adding DeepInfra, Vercel AI Gateway, Lambda AI, SambaNova, nScale, OVHcloud AI, Baseten, PublicAI, Moonshot AI, Meta Llama API, v0 (Vercel), Morph, Featherless AI, FriendliAI, LlamaGate, Galadriel, Weights & Biases Inference, Volcengine, AI21 Labs, Venice.ai, Codestral, Upstage, Maritalk, Xiaomi MiMo, Inference.net, NanoGPT, Predibase, Bytez, Heroku AI, Databricks, Snowflake Cortex, and GigaChat (Sber). OmniRoute now supports **100+ providers** (4 Free + 8 OAuth + 91 API Key + Custom compatible) - **Global Email Privacy Toggle:** Added a persistent eye-icon toggle button across all dashboard pages (Providers, Usage Limits, Playground) that reveals or hides masked email addresses. Toggle state is stored in localStorage and synced globally via Zustand store - **Documentation Refresh:** Updated README, ARCHITECTURE, FEATURES, AGENTS.md, and API_REFERENCE for v3.6.2 with accurate provider counts (100+), new executor list, and system API documentation -- **Uninstall Guide:** Created comprehensive `docs/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) +- **Uninstall Guide:** Created comprehensive `docs/guides/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) ### 🐛 Bug Fixes diff --git a/docs/i18n/ms/CONTRIBUTING.md b/docs/i18n/ms/CONTRIBUTING.md index 01ff8cea11..c1d1b075cc 100644 --- a/docs/i18n/ms/CONTRIBUTING.md +++ b/docs/i18n/ms/CONTRIBUTING.md @@ -153,7 +153,7 @@ Coverage notes: - If a PR changes production code in `src/`, `open-sse/`, `electron/`, or `bin/`, it must add or update automated tests in the same PR - `npm run coverage:report` prints the detailed file-by-file report from the latest coverage run - `npm run test:coverage:legacy` preserves the older metric for historical comparison -- See `docs/COVERAGE_PLAN.md` for the phased coverage improvement roadmap +- See `docs/ops/COVERAGE_PLAN.md` for the phased coverage improvement roadmap ### Pull Request Requirements @@ -305,7 +305,7 @@ Releases are managed via the `/generate-release` workflow. When a new GitHub Rel ## Getting Help -- **Architecture**: See [`docs/ARCHITECTURE.md`](docs/ARCHITECTURE.md) -- **API Reference**: See [`docs/API_REFERENCE.md`](docs/API_REFERENCE.md) +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](docs/architecture/ARCHITECTURE.md) +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](docs/reference/API_REFERENCE.md) - **Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) - **ADRs**: See `docs/adr/` for architectural decision records diff --git a/docs/i18n/ms/README.md b/docs/i18n/ms/README.md index e72f4836aa..77cd80d5a2 100644 --- a/docs/i18n/ms/README.md +++ b/docs/i18n/ms/README.md @@ -2267,25 +2267,25 @@ Se não quiser criar credenciais próprias agora, ainda é possível usar o flux ## Dokumentasi -| Document | Description | -| -------------------------------------------------------- | --------------------------------------------------- | -| [User Guide](docs/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | -| [API Reference](docs/API_REFERENCE.md) | All endpoints with examples | -| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | -| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | -| [Auto-Combo Engine](docs/AUTO-COMBO.md) | 6-factor scoring, mode packs, self-healing | -| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | -| [Troubleshooting](docs/TROUBLESHOOTING.md) | Common problems and solutions | -| [Architecture](docs/ARCHITECTURE.md) | System architecture and internals | -| [Codebase Documentation](docs/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | -| [Uninstall Guide](docs/UNINSTALL.md) | Clean removal for all install methods | -| [Environment Config](docs/ENVIRONMENT.md) | Complete `.env` variables and references | -| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | -| [OpenAPI Spec](docs/openapi.yaml) | OpenAPI 3.0 specification | -| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | -| [VM Deployment](docs/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | -| [Features Gallery](docs/FEATURES.md) | Visual dashboard tour with screenshots | -| [Release Checklist](docs/RELEASE_CHECKLIST.md) | Pre-release validation steps | +| Document | Description | +| --------------------------------------------------------------------- | --------------------------------------------------- | +| [User Guide](docs/guides/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | +| [API Reference](docs/reference/API_REFERENCE.md) | All endpoints with examples | +| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | +| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | +| [Auto-Combo Engine](docs/routing/AUTO-COMBO.md) | 6-factor scoring, mode packs, self-healing | +| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | +| [Troubleshooting](docs/guides/TROUBLESHOOTING.md) | Common problems and solutions | +| [Architecture](docs/architecture/ARCHITECTURE.md) | System architecture and internals | +| [Codebase Documentation](docs/architecture/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | +| [Uninstall Guide](docs/guides/UNINSTALL.md) | Clean removal for all install methods | +| [Environment Config](docs/reference/ENVIRONMENT.md) | Complete `.env` variables and references | +| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | +| [OpenAPI Spec](docs/reference/openapi.yaml) | OpenAPI 3.0 specification | +| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | +| [VM Deployment](docs/ops/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | +| [Features Gallery](docs/guides/FEATURES.md) | Visual dashboard tour with screenshots | +| [Release Checklist](docs/ops/RELEASE_CHECKLIST.md) | Pre-release validation steps | --- diff --git a/docs/i18n/ms/docs/ARCHITECTURE.md b/docs/i18n/ms/docs/architecture/ARCHITECTURE.md similarity index 100% rename from docs/i18n/ms/docs/ARCHITECTURE.md rename to docs/i18n/ms/docs/architecture/ARCHITECTURE.md diff --git a/docs/i18n/ms/docs/CODEBASE_DOCUMENTATION.md b/docs/i18n/ms/docs/architecture/CODEBASE_DOCUMENTATION.md similarity index 100% rename from docs/i18n/ms/docs/CODEBASE_DOCUMENTATION.md rename to docs/i18n/ms/docs/architecture/CODEBASE_DOCUMENTATION.md diff --git a/docs/i18n/ms/docs/A2A-SERVER.md b/docs/i18n/ms/docs/frameworks/A2A-SERVER.md similarity index 100% rename from docs/i18n/ms/docs/A2A-SERVER.md rename to docs/i18n/ms/docs/frameworks/A2A-SERVER.md diff --git a/docs/i18n/ms/docs/MCP-SERVER.md b/docs/i18n/ms/docs/frameworks/MCP-SERVER.md similarity index 100% rename from docs/i18n/ms/docs/MCP-SERVER.md rename to docs/i18n/ms/docs/frameworks/MCP-SERVER.md diff --git a/docs/i18n/ms/docs/FEATURES.md b/docs/i18n/ms/docs/guides/FEATURES.md similarity index 100% rename from docs/i18n/ms/docs/FEATURES.md rename to docs/i18n/ms/docs/guides/FEATURES.md diff --git a/docs/i18n/ms/docs/I18N.md b/docs/i18n/ms/docs/guides/I18N.md similarity index 99% rename from docs/i18n/ms/docs/I18N.md rename to docs/i18n/ms/docs/guides/I18N.md index 32a7ae2666..3f10814344 100644 --- a/docs/i18n/ms/docs/I18N.md +++ b/docs/i18n/ms/docs/guides/I18N.md @@ -420,7 +420,7 @@ The generator originally used `code: "in"` (deprecated Google Translate code) fo ### `docs/i18n/README.md` Is Auto-Generated -The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/I18N.md` (this file) for hand-written documentation that should persist. +The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/guides/I18N.md` (this file) for hand-written documentation that should persist. ### External Untranslatable Keys List diff --git a/docs/i18n/ms/docs/TROUBLESHOOTING.md b/docs/i18n/ms/docs/guides/TROUBLESHOOTING.md similarity index 98% rename from docs/i18n/ms/docs/TROUBLESHOOTING.md rename to docs/i18n/ms/docs/guides/TROUBLESHOOTING.md index 783753adda..60d6c32989 100644 --- a/docs/i18n/ms/docs/TROUBLESHOOTING.md +++ b/docs/i18n/ms/docs/guides/TROUBLESHOOTING.md @@ -335,7 +335,7 @@ You can ignore this section if you do not run RAG or agent pipelines behind Omni ## Still Stuck? - **GitHub Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) -- **Architecture**: See [`docs/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details -- **API Reference**: See [`docs/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints - **Health Dashboard**: Check **Dashboard → Health** for real-time system status - **Translator**: Use **Dashboard → Translator** to debug format issues diff --git a/docs/i18n/ms/docs/UNINSTALL.md b/docs/i18n/ms/docs/guides/UNINSTALL.md similarity index 100% rename from docs/i18n/ms/docs/UNINSTALL.md rename to docs/i18n/ms/docs/guides/UNINSTALL.md diff --git a/docs/i18n/ms/docs/USER_GUIDE.md b/docs/i18n/ms/docs/guides/USER_GUIDE.md similarity index 100% rename from docs/i18n/ms/docs/USER_GUIDE.md rename to docs/i18n/ms/docs/guides/USER_GUIDE.md diff --git a/docs/i18n/ms/docs/COVERAGE_PLAN.md b/docs/i18n/ms/docs/ops/COVERAGE_PLAN.md similarity index 100% rename from docs/i18n/ms/docs/COVERAGE_PLAN.md rename to docs/i18n/ms/docs/ops/COVERAGE_PLAN.md diff --git a/docs/i18n/ms/docs/FLY_IO_DEPLOYMENT_GUIDE.md b/docs/i18n/ms/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/ms/docs/FLY_IO_DEPLOYMENT_GUIDE.md rename to docs/i18n/ms/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/ms/docs/RELEASE_CHECKLIST.md b/docs/i18n/ms/docs/ops/RELEASE_CHECKLIST.md similarity index 94% rename from docs/i18n/ms/docs/RELEASE_CHECKLIST.md rename to docs/i18n/ms/docs/ops/RELEASE_CHECKLIST.md index 5ce7ee2a1d..0b72bdea50 100644 --- a/docs/i18n/ms/docs/RELEASE_CHECKLIST.md +++ b/docs/i18n/ms/docs/ops/RELEASE_CHECKLIST.md @@ -16,14 +16,14 @@ Use this checklist before tagging or publishing a new OmniRoute release. ## API Docs -1. Update `docs/openapi.yaml`: +1. Update `docs/reference/openapi.yaml`: - `info.version` must equal `package.json` version. 2. Validate endpoint examples if API contracts changed. ## Runtime Docs -1. Review `docs/ARCHITECTURE.md` for storage/runtime drift. -2. Review `docs/TROUBLESHOOTING.md` for env var and operational drift. +1. Review `docs/architecture/ARCHITECTURE.md` for storage/runtime drift. +2. Review `docs/guides/TROUBLESHOOTING.md` for env var and operational drift. 3. Verify the release/runtime Node.js version still satisfies the supported secure floor: - `>=20.20.2 <21` or `>=22.22.2 <23` - `npm run check:node-runtime` diff --git a/docs/i18n/ms/docs/VM_DEPLOYMENT_GUIDE.md b/docs/i18n/ms/docs/ops/VM_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/ms/docs/VM_DEPLOYMENT_GUIDE.md rename to docs/i18n/ms/docs/ops/VM_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/ms/docs/API_REFERENCE.md b/docs/i18n/ms/docs/reference/API_REFERENCE.md similarity index 100% rename from docs/i18n/ms/docs/API_REFERENCE.md rename to docs/i18n/ms/docs/reference/API_REFERENCE.md diff --git a/docs/i18n/ms/docs/CLI-TOOLS.md b/docs/i18n/ms/docs/reference/CLI-TOOLS.md similarity index 100% rename from docs/i18n/ms/docs/CLI-TOOLS.md rename to docs/i18n/ms/docs/reference/CLI-TOOLS.md diff --git a/docs/i18n/ms/docs/ENVIRONMENT.md b/docs/i18n/ms/docs/reference/ENVIRONMENT.md similarity index 100% rename from docs/i18n/ms/docs/ENVIRONMENT.md rename to docs/i18n/ms/docs/reference/ENVIRONMENT.md diff --git a/docs/i18n/ms/docs/AUTO-COMBO.md b/docs/i18n/ms/docs/routing/AUTO-COMBO.md similarity index 100% rename from docs/i18n/ms/docs/AUTO-COMBO.md rename to docs/i18n/ms/docs/routing/AUTO-COMBO.md diff --git a/docs/i18n/ms/llm.txt b/docs/i18n/ms/llm.txt index 1832e506f9..d2ddd056e4 100644 --- a/docs/i18n/ms/llm.txt +++ b/docs/i18n/ms/llm.txt @@ -357,11 +357,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### MCP Server (37 Tools) | Category | Tools | |------------|-------| -| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/MCP-SERVER.md` for full inventory) | +| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/frameworks/MCP-SERVER.md` for full inventory) | | Memory (3) | `memory_search`, `memory_add`, `memory_clear` | | Skills (4) | `skills_list`, `skills_enable`, `skills_execute`, `skills_executions` | -**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/MCP-SERVER.md`. +**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/frameworks/MCP-SERVER.md`. ### Provider Categories @@ -472,7 +472,7 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo 20. **Guardrails framework** in `src/lib/guardrails/` — hot-reloadable registry. Built-ins (priority-ordered): `vision-bridge` (5) → `pii-masker` (10) → `prompt-injection` (20). Fail-open model: exceptions never block traffic. Per-request opt-out via `x-omniroute-disabled-guardrails` header. -21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/AUTHZ_GUIDE.md`. +21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/architecture/AUTHZ_GUIDE.md`. 22. **Three resilience layers** are distinct (do not conflate them): - **Provider Circuit Breaker** (`src/shared/utils/circuitBreaker.ts`) — whole-provider scope. @@ -489,11 +489,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo - **MCP server expanded to 37 tools** (30 base + 3 memory + 4 skills) across ~13 scopes - **OAuth providers expanded to 14**: added Qwen, Kiro, Qoder, Gemini, Windsurf, GitLab Duo - **Coverage gate raised to 75/75/75/70** (was 60% across the board) — measured ~82% -- **Reasoning replay** (`docs/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams +- **Reasoning replay** (`docs/routing/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams - **Compliance + Evals + Webhooks** documentation introduced -- **Stealth guide** (`docs/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration -- **Tunnels guide** (`docs/TUNNELS_GUIDE.md`) — Cloudflare tunnel management -- **Electron guide** (`docs/ELECTRON_GUIDE.md`) — desktop app build + signing +- **Stealth guide** (`docs/security/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration +- **Tunnels guide** (`docs/ops/TUNNELS_GUIDE.md`) — Cloudflare tunnel management +- **Electron guide** (`docs/guides/ELECTRON_GUIDE.md`) — desktop app build + signing ## Links @@ -505,11 +505,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### Documentation Index -- **Architecture & Reference**: `docs/ARCHITECTURE.md`, `docs/CODEBASE_DOCUMENTATION.md`, `docs/REPOSITORY_MAP.md`, `docs/API_REFERENCE.md`, `docs/PROVIDER_REFERENCE.md`, `docs/openapi.yaml` -- **Operator guides**: `docs/USER_GUIDE.md`, `docs/CLI-TOOLS.md`, `docs/TROUBLESHOOTING.md`, `docs/COVERAGE_PLAN.md` -- **Protocols**: `docs/MCP-SERVER.md`, `docs/A2A-SERVER.md`, `docs/AGENT_PROTOCOLS_GUIDE.md`, `docs/CLOUD_AGENT.md` -- **Routing & resilience**: `docs/AUTO-COMBO.md`, `docs/RESILIENCE_GUIDE.md` -- **Security**: `docs/AUTHZ_GUIDE.md`, `docs/GUARDRAILS.md`, `docs/COMPLIANCE.md`, `docs/STEALTH_GUIDE.md` -- **Extensibility**: `docs/SKILLS.md`, `docs/MEMORY.md`, `docs/EVALS.md`, `docs/WEBHOOKS.md`, `docs/REASONING_REPLAY.md` -- **Platform**: `docs/ELECTRON_GUIDE.md`, `docs/TUNNELS_GUIDE.md` +- **Architecture & Reference**: `docs/architecture/ARCHITECTURE.md`, `docs/architecture/CODEBASE_DOCUMENTATION.md`, `docs/architecture/REPOSITORY_MAP.md`, `docs/reference/API_REFERENCE.md`, `docs/reference/PROVIDER_REFERENCE.md`, `docs/reference/openapi.yaml` +- **Operator guides**: `docs/guides/USER_GUIDE.md`, `docs/reference/CLI-TOOLS.md`, `docs/guides/TROUBLESHOOTING.md`, `docs/ops/COVERAGE_PLAN.md` +- **Protocols**: `docs/frameworks/MCP-SERVER.md`, `docs/frameworks/A2A-SERVER.md`, `docs/frameworks/AGENT_PROTOCOLS_GUIDE.md`, `docs/frameworks/CLOUD_AGENT.md` +- **Routing & resilience**: `docs/routing/AUTO-COMBO.md`, `docs/architecture/RESILIENCE_GUIDE.md` +- **Security**: `docs/architecture/AUTHZ_GUIDE.md`, `docs/security/GUARDRAILS.md`, `docs/security/COMPLIANCE.md`, `docs/security/STEALTH_GUIDE.md` +- **Extensibility**: `docs/frameworks/SKILLS.md`, `docs/frameworks/MEMORY.md`, `docs/frameworks/EVALS.md`, `docs/frameworks/WEBHOOKS.md`, `docs/routing/REASONING_REPLAY.md` +- **Platform**: `docs/guides/ELECTRON_GUIDE.md`, `docs/ops/TUNNELS_GUIDE.md` - **AI agents**: `CLAUDE.md`, `AGENTS.md`, `GEMINI.md` diff --git a/docs/i18n/nl/CHANGELOG.md b/docs/i18n/nl/CHANGELOG.md index b7d1d9ddb9..67fba02475 100644 --- a/docs/i18n/nl/CHANGELOG.md +++ b/docs/i18n/nl/CHANGELOG.md @@ -1310,7 +1310,7 @@ We identified that **155 community PRs** across the entire project history (from - **33 New API Key Providers:** Massive provider expansion adding DeepInfra, Vercel AI Gateway, Lambda AI, SambaNova, nScale, OVHcloud AI, Baseten, PublicAI, Moonshot AI, Meta Llama API, v0 (Vercel), Morph, Featherless AI, FriendliAI, LlamaGate, Galadriel, Weights & Biases Inference, Volcengine, AI21 Labs, Venice.ai, Codestral, Upstage, Maritalk, Xiaomi MiMo, Inference.net, NanoGPT, Predibase, Bytez, Heroku AI, Databricks, Snowflake Cortex, and GigaChat (Sber). OmniRoute now supports **100+ providers** (4 Free + 8 OAuth + 91 API Key + Custom compatible) - **Global Email Privacy Toggle:** Added a persistent eye-icon toggle button across all dashboard pages (Providers, Usage Limits, Playground) that reveals or hides masked email addresses. Toggle state is stored in localStorage and synced globally via Zustand store - **Documentation Refresh:** Updated README, ARCHITECTURE, FEATURES, AGENTS.md, and API_REFERENCE for v3.6.2 with accurate provider counts (100+), new executor list, and system API documentation -- **Uninstall Guide:** Created comprehensive `docs/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) +- **Uninstall Guide:** Created comprehensive `docs/guides/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) ### 🐛 Bug Fixes diff --git a/docs/i18n/nl/CONTRIBUTING.md b/docs/i18n/nl/CONTRIBUTING.md index c4f98b51dd..ca6e96dde6 100644 --- a/docs/i18n/nl/CONTRIBUTING.md +++ b/docs/i18n/nl/CONTRIBUTING.md @@ -153,7 +153,7 @@ Coverage notes: - If a PR changes production code in `src/`, `open-sse/`, `electron/`, or `bin/`, it must add or update automated tests in the same PR - `npm run coverage:report` prints the detailed file-by-file report from the latest coverage run - `npm run test:coverage:legacy` preserves the older metric for historical comparison -- See `docs/COVERAGE_PLAN.md` for the phased coverage improvement roadmap +- See `docs/ops/COVERAGE_PLAN.md` for the phased coverage improvement roadmap ### Pull Request Requirements @@ -305,7 +305,7 @@ Releases are managed via the `/generate-release` workflow. When a new GitHub Rel ## Getting Help -- **Architecture**: See [`docs/ARCHITECTURE.md`](docs/ARCHITECTURE.md) -- **API Reference**: See [`docs/API_REFERENCE.md`](docs/API_REFERENCE.md) +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](docs/architecture/ARCHITECTURE.md) +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](docs/reference/API_REFERENCE.md) - **Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) - **ADRs**: See `docs/adr/` for architectural decision records diff --git a/docs/i18n/nl/README.md b/docs/i18n/nl/README.md index 785745103c..466bb310a3 100644 --- a/docs/i18n/nl/README.md +++ b/docs/i18n/nl/README.md @@ -2267,25 +2267,25 @@ Se não quiser criar credenciais próprias agora, ainda é possível usar o flux ## Documentatie -| Document | Description | -| -------------------------------------------------------- | --------------------------------------------------- | -| [User Guide](docs/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | -| [API Reference](docs/API_REFERENCE.md) | All endpoints with examples | -| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | -| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | -| [Auto-Combo Engine](docs/AUTO-COMBO.md) | 6-factor scoring, mode packs, self-healing | -| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | -| [Troubleshooting](docs/TROUBLESHOOTING.md) | Common problems and solutions | -| [Architecture](docs/ARCHITECTURE.md) | System architecture and internals | -| [Codebase Documentation](docs/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | -| [Uninstall Guide](docs/UNINSTALL.md) | Clean removal for all install methods | -| [Environment Config](docs/ENVIRONMENT.md) | Complete `.env` variables and references | -| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | -| [OpenAPI Spec](docs/openapi.yaml) | OpenAPI 3.0 specification | -| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | -| [VM Deployment](docs/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | -| [Features Gallery](docs/FEATURES.md) | Visual dashboard tour with screenshots | -| [Release Checklist](docs/RELEASE_CHECKLIST.md) | Pre-release validation steps | +| Document | Description | +| --------------------------------------------------------------------- | --------------------------------------------------- | +| [User Guide](docs/guides/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | +| [API Reference](docs/reference/API_REFERENCE.md) | All endpoints with examples | +| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | +| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | +| [Auto-Combo Engine](docs/routing/AUTO-COMBO.md) | 6-factor scoring, mode packs, self-healing | +| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | +| [Troubleshooting](docs/guides/TROUBLESHOOTING.md) | Common problems and solutions | +| [Architecture](docs/architecture/ARCHITECTURE.md) | System architecture and internals | +| [Codebase Documentation](docs/architecture/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | +| [Uninstall Guide](docs/guides/UNINSTALL.md) | Clean removal for all install methods | +| [Environment Config](docs/reference/ENVIRONMENT.md) | Complete `.env` variables and references | +| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | +| [OpenAPI Spec](docs/reference/openapi.yaml) | OpenAPI 3.0 specification | +| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | +| [VM Deployment](docs/ops/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | +| [Features Gallery](docs/guides/FEATURES.md) | Visual dashboard tour with screenshots | +| [Release Checklist](docs/ops/RELEASE_CHECKLIST.md) | Pre-release validation steps | --- diff --git a/docs/i18n/nl/docs/ARCHITECTURE.md b/docs/i18n/nl/docs/architecture/ARCHITECTURE.md similarity index 100% rename from docs/i18n/nl/docs/ARCHITECTURE.md rename to docs/i18n/nl/docs/architecture/ARCHITECTURE.md diff --git a/docs/i18n/nl/docs/CODEBASE_DOCUMENTATION.md b/docs/i18n/nl/docs/architecture/CODEBASE_DOCUMENTATION.md similarity index 100% rename from docs/i18n/nl/docs/CODEBASE_DOCUMENTATION.md rename to docs/i18n/nl/docs/architecture/CODEBASE_DOCUMENTATION.md diff --git a/docs/i18n/nl/docs/A2A-SERVER.md b/docs/i18n/nl/docs/frameworks/A2A-SERVER.md similarity index 100% rename from docs/i18n/nl/docs/A2A-SERVER.md rename to docs/i18n/nl/docs/frameworks/A2A-SERVER.md diff --git a/docs/i18n/nl/docs/MCP-SERVER.md b/docs/i18n/nl/docs/frameworks/MCP-SERVER.md similarity index 100% rename from docs/i18n/nl/docs/MCP-SERVER.md rename to docs/i18n/nl/docs/frameworks/MCP-SERVER.md diff --git a/docs/i18n/nl/docs/FEATURES.md b/docs/i18n/nl/docs/guides/FEATURES.md similarity index 100% rename from docs/i18n/nl/docs/FEATURES.md rename to docs/i18n/nl/docs/guides/FEATURES.md diff --git a/docs/i18n/nl/docs/I18N.md b/docs/i18n/nl/docs/guides/I18N.md similarity index 99% rename from docs/i18n/nl/docs/I18N.md rename to docs/i18n/nl/docs/guides/I18N.md index 9fd7cf8177..3dd44035b2 100644 --- a/docs/i18n/nl/docs/I18N.md +++ b/docs/i18n/nl/docs/guides/I18N.md @@ -420,7 +420,7 @@ The generator originally used `code: "in"` (deprecated Google Translate code) fo ### `docs/i18n/README.md` Is Auto-Generated -The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/I18N.md` (this file) for hand-written documentation that should persist. +The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/guides/I18N.md` (this file) for hand-written documentation that should persist. ### External Untranslatable Keys List diff --git a/docs/i18n/nl/docs/TROUBLESHOOTING.md b/docs/i18n/nl/docs/guides/TROUBLESHOOTING.md similarity index 98% rename from docs/i18n/nl/docs/TROUBLESHOOTING.md rename to docs/i18n/nl/docs/guides/TROUBLESHOOTING.md index 3d9b54fd47..17d12ce29c 100644 --- a/docs/i18n/nl/docs/TROUBLESHOOTING.md +++ b/docs/i18n/nl/docs/guides/TROUBLESHOOTING.md @@ -335,7 +335,7 @@ You can ignore this section if you do not run RAG or agent pipelines behind Omni ## Still Stuck? - **GitHub Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) -- **Architecture**: See [`docs/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details -- **API Reference**: See [`docs/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints - **Health Dashboard**: Check **Dashboard → Health** for real-time system status - **Translator**: Use **Dashboard → Translator** to debug format issues diff --git a/docs/i18n/nl/docs/UNINSTALL.md b/docs/i18n/nl/docs/guides/UNINSTALL.md similarity index 100% rename from docs/i18n/nl/docs/UNINSTALL.md rename to docs/i18n/nl/docs/guides/UNINSTALL.md diff --git a/docs/i18n/nl/docs/USER_GUIDE.md b/docs/i18n/nl/docs/guides/USER_GUIDE.md similarity index 100% rename from docs/i18n/nl/docs/USER_GUIDE.md rename to docs/i18n/nl/docs/guides/USER_GUIDE.md diff --git a/docs/i18n/nl/docs/COVERAGE_PLAN.md b/docs/i18n/nl/docs/ops/COVERAGE_PLAN.md similarity index 100% rename from docs/i18n/nl/docs/COVERAGE_PLAN.md rename to docs/i18n/nl/docs/ops/COVERAGE_PLAN.md diff --git a/docs/i18n/nl/docs/FLY_IO_DEPLOYMENT_GUIDE.md b/docs/i18n/nl/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/nl/docs/FLY_IO_DEPLOYMENT_GUIDE.md rename to docs/i18n/nl/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/nl/docs/RELEASE_CHECKLIST.md b/docs/i18n/nl/docs/ops/RELEASE_CHECKLIST.md similarity index 94% rename from docs/i18n/nl/docs/RELEASE_CHECKLIST.md rename to docs/i18n/nl/docs/ops/RELEASE_CHECKLIST.md index 43e0525388..18744d5607 100644 --- a/docs/i18n/nl/docs/RELEASE_CHECKLIST.md +++ b/docs/i18n/nl/docs/ops/RELEASE_CHECKLIST.md @@ -16,14 +16,14 @@ Use this checklist before tagging or publishing a new OmniRoute release. ## API Docs -1. Update `docs/openapi.yaml`: +1. Update `docs/reference/openapi.yaml`: - `info.version` must equal `package.json` version. 2. Validate endpoint examples if API contracts changed. ## Runtime Docs -1. Review `docs/ARCHITECTURE.md` for storage/runtime drift. -2. Review `docs/TROUBLESHOOTING.md` for env var and operational drift. +1. Review `docs/architecture/ARCHITECTURE.md` for storage/runtime drift. +2. Review `docs/guides/TROUBLESHOOTING.md` for env var and operational drift. 3. Verify the release/runtime Node.js version still satisfies the supported secure floor: - `>=20.20.2 <21` or `>=22.22.2 <23` - `npm run check:node-runtime` diff --git a/docs/i18n/nl/docs/VM_DEPLOYMENT_GUIDE.md b/docs/i18n/nl/docs/ops/VM_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/nl/docs/VM_DEPLOYMENT_GUIDE.md rename to docs/i18n/nl/docs/ops/VM_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/nl/docs/API_REFERENCE.md b/docs/i18n/nl/docs/reference/API_REFERENCE.md similarity index 100% rename from docs/i18n/nl/docs/API_REFERENCE.md rename to docs/i18n/nl/docs/reference/API_REFERENCE.md diff --git a/docs/i18n/nl/docs/CLI-TOOLS.md b/docs/i18n/nl/docs/reference/CLI-TOOLS.md similarity index 100% rename from docs/i18n/nl/docs/CLI-TOOLS.md rename to docs/i18n/nl/docs/reference/CLI-TOOLS.md diff --git a/docs/i18n/nl/docs/ENVIRONMENT.md b/docs/i18n/nl/docs/reference/ENVIRONMENT.md similarity index 100% rename from docs/i18n/nl/docs/ENVIRONMENT.md rename to docs/i18n/nl/docs/reference/ENVIRONMENT.md diff --git a/docs/i18n/nl/docs/AUTO-COMBO.md b/docs/i18n/nl/docs/routing/AUTO-COMBO.md similarity index 100% rename from docs/i18n/nl/docs/AUTO-COMBO.md rename to docs/i18n/nl/docs/routing/AUTO-COMBO.md diff --git a/docs/i18n/nl/llm.txt b/docs/i18n/nl/llm.txt index dca3cd438e..6836a11da2 100644 --- a/docs/i18n/nl/llm.txt +++ b/docs/i18n/nl/llm.txt @@ -357,11 +357,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### MCP Server (37 Tools) | Category | Tools | |------------|-------| -| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/MCP-SERVER.md` for full inventory) | +| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/frameworks/MCP-SERVER.md` for full inventory) | | Memory (3) | `memory_search`, `memory_add`, `memory_clear` | | Skills (4) | `skills_list`, `skills_enable`, `skills_execute`, `skills_executions` | -**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/MCP-SERVER.md`. +**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/frameworks/MCP-SERVER.md`. ### Provider Categories @@ -472,7 +472,7 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo 20. **Guardrails framework** in `src/lib/guardrails/` — hot-reloadable registry. Built-ins (priority-ordered): `vision-bridge` (5) → `pii-masker` (10) → `prompt-injection` (20). Fail-open model: exceptions never block traffic. Per-request opt-out via `x-omniroute-disabled-guardrails` header. -21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/AUTHZ_GUIDE.md`. +21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/architecture/AUTHZ_GUIDE.md`. 22. **Three resilience layers** are distinct (do not conflate them): - **Provider Circuit Breaker** (`src/shared/utils/circuitBreaker.ts`) — whole-provider scope. @@ -489,11 +489,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo - **MCP server expanded to 37 tools** (30 base + 3 memory + 4 skills) across ~13 scopes - **OAuth providers expanded to 14**: added Qwen, Kiro, Qoder, Gemini, Windsurf, GitLab Duo - **Coverage gate raised to 75/75/75/70** (was 60% across the board) — measured ~82% -- **Reasoning replay** (`docs/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams +- **Reasoning replay** (`docs/routing/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams - **Compliance + Evals + Webhooks** documentation introduced -- **Stealth guide** (`docs/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration -- **Tunnels guide** (`docs/TUNNELS_GUIDE.md`) — Cloudflare tunnel management -- **Electron guide** (`docs/ELECTRON_GUIDE.md`) — desktop app build + signing +- **Stealth guide** (`docs/security/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration +- **Tunnels guide** (`docs/ops/TUNNELS_GUIDE.md`) — Cloudflare tunnel management +- **Electron guide** (`docs/guides/ELECTRON_GUIDE.md`) — desktop app build + signing ## Links @@ -505,11 +505,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### Documentation Index -- **Architecture & Reference**: `docs/ARCHITECTURE.md`, `docs/CODEBASE_DOCUMENTATION.md`, `docs/REPOSITORY_MAP.md`, `docs/API_REFERENCE.md`, `docs/PROVIDER_REFERENCE.md`, `docs/openapi.yaml` -- **Operator guides**: `docs/USER_GUIDE.md`, `docs/CLI-TOOLS.md`, `docs/TROUBLESHOOTING.md`, `docs/COVERAGE_PLAN.md` -- **Protocols**: `docs/MCP-SERVER.md`, `docs/A2A-SERVER.md`, `docs/AGENT_PROTOCOLS_GUIDE.md`, `docs/CLOUD_AGENT.md` -- **Routing & resilience**: `docs/AUTO-COMBO.md`, `docs/RESILIENCE_GUIDE.md` -- **Security**: `docs/AUTHZ_GUIDE.md`, `docs/GUARDRAILS.md`, `docs/COMPLIANCE.md`, `docs/STEALTH_GUIDE.md` -- **Extensibility**: `docs/SKILLS.md`, `docs/MEMORY.md`, `docs/EVALS.md`, `docs/WEBHOOKS.md`, `docs/REASONING_REPLAY.md` -- **Platform**: `docs/ELECTRON_GUIDE.md`, `docs/TUNNELS_GUIDE.md` +- **Architecture & Reference**: `docs/architecture/ARCHITECTURE.md`, `docs/architecture/CODEBASE_DOCUMENTATION.md`, `docs/architecture/REPOSITORY_MAP.md`, `docs/reference/API_REFERENCE.md`, `docs/reference/PROVIDER_REFERENCE.md`, `docs/reference/openapi.yaml` +- **Operator guides**: `docs/guides/USER_GUIDE.md`, `docs/reference/CLI-TOOLS.md`, `docs/guides/TROUBLESHOOTING.md`, `docs/ops/COVERAGE_PLAN.md` +- **Protocols**: `docs/frameworks/MCP-SERVER.md`, `docs/frameworks/A2A-SERVER.md`, `docs/frameworks/AGENT_PROTOCOLS_GUIDE.md`, `docs/frameworks/CLOUD_AGENT.md` +- **Routing & resilience**: `docs/routing/AUTO-COMBO.md`, `docs/architecture/RESILIENCE_GUIDE.md` +- **Security**: `docs/architecture/AUTHZ_GUIDE.md`, `docs/security/GUARDRAILS.md`, `docs/security/COMPLIANCE.md`, `docs/security/STEALTH_GUIDE.md` +- **Extensibility**: `docs/frameworks/SKILLS.md`, `docs/frameworks/MEMORY.md`, `docs/frameworks/EVALS.md`, `docs/frameworks/WEBHOOKS.md`, `docs/routing/REASONING_REPLAY.md` +- **Platform**: `docs/guides/ELECTRON_GUIDE.md`, `docs/ops/TUNNELS_GUIDE.md` - **AI agents**: `CLAUDE.md`, `AGENTS.md`, `GEMINI.md` diff --git a/docs/i18n/no/CHANGELOG.md b/docs/i18n/no/CHANGELOG.md index 9766c019d6..7c8a3d4dea 100644 --- a/docs/i18n/no/CHANGELOG.md +++ b/docs/i18n/no/CHANGELOG.md @@ -1310,7 +1310,7 @@ We identified that **155 community PRs** across the entire project history (from - **33 New API Key Providers:** Massive provider expansion adding DeepInfra, Vercel AI Gateway, Lambda AI, SambaNova, nScale, OVHcloud AI, Baseten, PublicAI, Moonshot AI, Meta Llama API, v0 (Vercel), Morph, Featherless AI, FriendliAI, LlamaGate, Galadriel, Weights & Biases Inference, Volcengine, AI21 Labs, Venice.ai, Codestral, Upstage, Maritalk, Xiaomi MiMo, Inference.net, NanoGPT, Predibase, Bytez, Heroku AI, Databricks, Snowflake Cortex, and GigaChat (Sber). OmniRoute now supports **100+ providers** (4 Free + 8 OAuth + 91 API Key + Custom compatible) - **Global Email Privacy Toggle:** Added a persistent eye-icon toggle button across all dashboard pages (Providers, Usage Limits, Playground) that reveals or hides masked email addresses. Toggle state is stored in localStorage and synced globally via Zustand store - **Documentation Refresh:** Updated README, ARCHITECTURE, FEATURES, AGENTS.md, and API_REFERENCE for v3.6.2 with accurate provider counts (100+), new executor list, and system API documentation -- **Uninstall Guide:** Created comprehensive `docs/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) +- **Uninstall Guide:** Created comprehensive `docs/guides/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) ### 🐛 Bug Fixes diff --git a/docs/i18n/no/CONTRIBUTING.md b/docs/i18n/no/CONTRIBUTING.md index a801aeb9dd..5459dfed5a 100644 --- a/docs/i18n/no/CONTRIBUTING.md +++ b/docs/i18n/no/CONTRIBUTING.md @@ -153,7 +153,7 @@ Coverage notes: - If a PR changes production code in `src/`, `open-sse/`, `electron/`, or `bin/`, it must add or update automated tests in the same PR - `npm run coverage:report` prints the detailed file-by-file report from the latest coverage run - `npm run test:coverage:legacy` preserves the older metric for historical comparison -- See `docs/COVERAGE_PLAN.md` for the phased coverage improvement roadmap +- See `docs/ops/COVERAGE_PLAN.md` for the phased coverage improvement roadmap ### Pull Request Requirements @@ -305,7 +305,7 @@ Releases are managed via the `/generate-release` workflow. When a new GitHub Rel ## Getting Help -- **Architecture**: See [`docs/ARCHITECTURE.md`](docs/ARCHITECTURE.md) -- **API Reference**: See [`docs/API_REFERENCE.md`](docs/API_REFERENCE.md) +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](docs/architecture/ARCHITECTURE.md) +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](docs/reference/API_REFERENCE.md) - **Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) - **ADRs**: See `docs/adr/` for architectural decision records diff --git a/docs/i18n/no/README.md b/docs/i18n/no/README.md index 9e62629c89..9420865d74 100644 --- a/docs/i18n/no/README.md +++ b/docs/i18n/no/README.md @@ -2267,25 +2267,25 @@ Se não quiser criar credenciais próprias agora, ainda é possível usar o flux ## Dokumentasjon -| Document | Description | -| -------------------------------------------------------- | --------------------------------------------------- | -| [User Guide](docs/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | -| [API Reference](docs/API_REFERENCE.md) | All endpoints with examples | -| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | -| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | -| [Auto-Combo Engine](docs/AUTO-COMBO.md) | 6-factor scoring, mode packs, self-healing | -| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | -| [Troubleshooting](docs/TROUBLESHOOTING.md) | Common problems and solutions | -| [Architecture](docs/ARCHITECTURE.md) | System architecture and internals | -| [Codebase Documentation](docs/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | -| [Uninstall Guide](docs/UNINSTALL.md) | Clean removal for all install methods | -| [Environment Config](docs/ENVIRONMENT.md) | Complete `.env` variables and references | -| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | -| [OpenAPI Spec](docs/openapi.yaml) | OpenAPI 3.0 specification | -| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | -| [VM Deployment](docs/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | -| [Features Gallery](docs/FEATURES.md) | Visual dashboard tour with screenshots | -| [Release Checklist](docs/RELEASE_CHECKLIST.md) | Pre-release validation steps | +| Document | Description | +| --------------------------------------------------------------------- | --------------------------------------------------- | +| [User Guide](docs/guides/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | +| [API Reference](docs/reference/API_REFERENCE.md) | All endpoints with examples | +| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | +| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | +| [Auto-Combo Engine](docs/routing/AUTO-COMBO.md) | 6-factor scoring, mode packs, self-healing | +| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | +| [Troubleshooting](docs/guides/TROUBLESHOOTING.md) | Common problems and solutions | +| [Architecture](docs/architecture/ARCHITECTURE.md) | System architecture and internals | +| [Codebase Documentation](docs/architecture/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | +| [Uninstall Guide](docs/guides/UNINSTALL.md) | Clean removal for all install methods | +| [Environment Config](docs/reference/ENVIRONMENT.md) | Complete `.env` variables and references | +| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | +| [OpenAPI Spec](docs/reference/openapi.yaml) | OpenAPI 3.0 specification | +| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | +| [VM Deployment](docs/ops/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | +| [Features Gallery](docs/guides/FEATURES.md) | Visual dashboard tour with screenshots | +| [Release Checklist](docs/ops/RELEASE_CHECKLIST.md) | Pre-release validation steps | --- diff --git a/docs/i18n/no/docs/ARCHITECTURE.md b/docs/i18n/no/docs/architecture/ARCHITECTURE.md similarity index 100% rename from docs/i18n/no/docs/ARCHITECTURE.md rename to docs/i18n/no/docs/architecture/ARCHITECTURE.md diff --git a/docs/i18n/no/docs/CODEBASE_DOCUMENTATION.md b/docs/i18n/no/docs/architecture/CODEBASE_DOCUMENTATION.md similarity index 100% rename from docs/i18n/no/docs/CODEBASE_DOCUMENTATION.md rename to docs/i18n/no/docs/architecture/CODEBASE_DOCUMENTATION.md diff --git a/docs/i18n/no/docs/A2A-SERVER.md b/docs/i18n/no/docs/frameworks/A2A-SERVER.md similarity index 100% rename from docs/i18n/no/docs/A2A-SERVER.md rename to docs/i18n/no/docs/frameworks/A2A-SERVER.md diff --git a/docs/i18n/no/docs/MCP-SERVER.md b/docs/i18n/no/docs/frameworks/MCP-SERVER.md similarity index 100% rename from docs/i18n/no/docs/MCP-SERVER.md rename to docs/i18n/no/docs/frameworks/MCP-SERVER.md diff --git a/docs/i18n/no/docs/FEATURES.md b/docs/i18n/no/docs/guides/FEATURES.md similarity index 100% rename from docs/i18n/no/docs/FEATURES.md rename to docs/i18n/no/docs/guides/FEATURES.md diff --git a/docs/i18n/no/docs/I18N.md b/docs/i18n/no/docs/guides/I18N.md similarity index 99% rename from docs/i18n/no/docs/I18N.md rename to docs/i18n/no/docs/guides/I18N.md index e4d19f8df8..748bbcc3c4 100644 --- a/docs/i18n/no/docs/I18N.md +++ b/docs/i18n/no/docs/guides/I18N.md @@ -420,7 +420,7 @@ The generator originally used `code: "in"` (deprecated Google Translate code) fo ### `docs/i18n/README.md` Is Auto-Generated -The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/I18N.md` (this file) for hand-written documentation that should persist. +The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/guides/I18N.md` (this file) for hand-written documentation that should persist. ### External Untranslatable Keys List diff --git a/docs/i18n/no/docs/TROUBLESHOOTING.md b/docs/i18n/no/docs/guides/TROUBLESHOOTING.md similarity index 98% rename from docs/i18n/no/docs/TROUBLESHOOTING.md rename to docs/i18n/no/docs/guides/TROUBLESHOOTING.md index e90f23b8c9..7cb3399476 100644 --- a/docs/i18n/no/docs/TROUBLESHOOTING.md +++ b/docs/i18n/no/docs/guides/TROUBLESHOOTING.md @@ -335,7 +335,7 @@ You can ignore this section if you do not run RAG or agent pipelines behind Omni ## Still Stuck? - **GitHub Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) -- **Architecture**: See [`docs/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details -- **API Reference**: See [`docs/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints - **Health Dashboard**: Check **Dashboard → Health** for real-time system status - **Translator**: Use **Dashboard → Translator** to debug format issues diff --git a/docs/i18n/no/docs/UNINSTALL.md b/docs/i18n/no/docs/guides/UNINSTALL.md similarity index 100% rename from docs/i18n/no/docs/UNINSTALL.md rename to docs/i18n/no/docs/guides/UNINSTALL.md diff --git a/docs/i18n/no/docs/USER_GUIDE.md b/docs/i18n/no/docs/guides/USER_GUIDE.md similarity index 100% rename from docs/i18n/no/docs/USER_GUIDE.md rename to docs/i18n/no/docs/guides/USER_GUIDE.md diff --git a/docs/i18n/no/docs/COVERAGE_PLAN.md b/docs/i18n/no/docs/ops/COVERAGE_PLAN.md similarity index 100% rename from docs/i18n/no/docs/COVERAGE_PLAN.md rename to docs/i18n/no/docs/ops/COVERAGE_PLAN.md diff --git a/docs/i18n/no/docs/FLY_IO_DEPLOYMENT_GUIDE.md b/docs/i18n/no/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/no/docs/FLY_IO_DEPLOYMENT_GUIDE.md rename to docs/i18n/no/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/no/docs/RELEASE_CHECKLIST.md b/docs/i18n/no/docs/ops/RELEASE_CHECKLIST.md similarity index 94% rename from docs/i18n/no/docs/RELEASE_CHECKLIST.md rename to docs/i18n/no/docs/ops/RELEASE_CHECKLIST.md index 025006df1e..19919c4f96 100644 --- a/docs/i18n/no/docs/RELEASE_CHECKLIST.md +++ b/docs/i18n/no/docs/ops/RELEASE_CHECKLIST.md @@ -16,14 +16,14 @@ Use this checklist before tagging or publishing a new OmniRoute release. ## API Docs -1. Update `docs/openapi.yaml`: +1. Update `docs/reference/openapi.yaml`: - `info.version` must equal `package.json` version. 2. Validate endpoint examples if API contracts changed. ## Runtime Docs -1. Review `docs/ARCHITECTURE.md` for storage/runtime drift. -2. Review `docs/TROUBLESHOOTING.md` for env var and operational drift. +1. Review `docs/architecture/ARCHITECTURE.md` for storage/runtime drift. +2. Review `docs/guides/TROUBLESHOOTING.md` for env var and operational drift. 3. Verify the release/runtime Node.js version still satisfies the supported secure floor: - `>=20.20.2 <21` or `>=22.22.2 <23` - `npm run check:node-runtime` diff --git a/docs/i18n/no/docs/VM_DEPLOYMENT_GUIDE.md b/docs/i18n/no/docs/ops/VM_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/no/docs/VM_DEPLOYMENT_GUIDE.md rename to docs/i18n/no/docs/ops/VM_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/no/docs/API_REFERENCE.md b/docs/i18n/no/docs/reference/API_REFERENCE.md similarity index 100% rename from docs/i18n/no/docs/API_REFERENCE.md rename to docs/i18n/no/docs/reference/API_REFERENCE.md diff --git a/docs/i18n/no/docs/CLI-TOOLS.md b/docs/i18n/no/docs/reference/CLI-TOOLS.md similarity index 100% rename from docs/i18n/no/docs/CLI-TOOLS.md rename to docs/i18n/no/docs/reference/CLI-TOOLS.md diff --git a/docs/i18n/no/docs/ENVIRONMENT.md b/docs/i18n/no/docs/reference/ENVIRONMENT.md similarity index 100% rename from docs/i18n/no/docs/ENVIRONMENT.md rename to docs/i18n/no/docs/reference/ENVIRONMENT.md diff --git a/docs/i18n/no/docs/AUTO-COMBO.md b/docs/i18n/no/docs/routing/AUTO-COMBO.md similarity index 100% rename from docs/i18n/no/docs/AUTO-COMBO.md rename to docs/i18n/no/docs/routing/AUTO-COMBO.md diff --git a/docs/i18n/no/llm.txt b/docs/i18n/no/llm.txt index 0471d80fed..0016785cb5 100644 --- a/docs/i18n/no/llm.txt +++ b/docs/i18n/no/llm.txt @@ -357,11 +357,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### MCP Server (37 Tools) | Category | Tools | |------------|-------| -| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/MCP-SERVER.md` for full inventory) | +| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/frameworks/MCP-SERVER.md` for full inventory) | | Memory (3) | `memory_search`, `memory_add`, `memory_clear` | | Skills (4) | `skills_list`, `skills_enable`, `skills_execute`, `skills_executions` | -**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/MCP-SERVER.md`. +**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/frameworks/MCP-SERVER.md`. ### Provider Categories @@ -472,7 +472,7 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo 20. **Guardrails framework** in `src/lib/guardrails/` — hot-reloadable registry. Built-ins (priority-ordered): `vision-bridge` (5) → `pii-masker` (10) → `prompt-injection` (20). Fail-open model: exceptions never block traffic. Per-request opt-out via `x-omniroute-disabled-guardrails` header. -21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/AUTHZ_GUIDE.md`. +21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/architecture/AUTHZ_GUIDE.md`. 22. **Three resilience layers** are distinct (do not conflate them): - **Provider Circuit Breaker** (`src/shared/utils/circuitBreaker.ts`) — whole-provider scope. @@ -489,11 +489,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo - **MCP server expanded to 37 tools** (30 base + 3 memory + 4 skills) across ~13 scopes - **OAuth providers expanded to 14**: added Qwen, Kiro, Qoder, Gemini, Windsurf, GitLab Duo - **Coverage gate raised to 75/75/75/70** (was 60% across the board) — measured ~82% -- **Reasoning replay** (`docs/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams +- **Reasoning replay** (`docs/routing/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams - **Compliance + Evals + Webhooks** documentation introduced -- **Stealth guide** (`docs/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration -- **Tunnels guide** (`docs/TUNNELS_GUIDE.md`) — Cloudflare tunnel management -- **Electron guide** (`docs/ELECTRON_GUIDE.md`) — desktop app build + signing +- **Stealth guide** (`docs/security/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration +- **Tunnels guide** (`docs/ops/TUNNELS_GUIDE.md`) — Cloudflare tunnel management +- **Electron guide** (`docs/guides/ELECTRON_GUIDE.md`) — desktop app build + signing ## Links @@ -505,11 +505,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### Documentation Index -- **Architecture & Reference**: `docs/ARCHITECTURE.md`, `docs/CODEBASE_DOCUMENTATION.md`, `docs/REPOSITORY_MAP.md`, `docs/API_REFERENCE.md`, `docs/PROVIDER_REFERENCE.md`, `docs/openapi.yaml` -- **Operator guides**: `docs/USER_GUIDE.md`, `docs/CLI-TOOLS.md`, `docs/TROUBLESHOOTING.md`, `docs/COVERAGE_PLAN.md` -- **Protocols**: `docs/MCP-SERVER.md`, `docs/A2A-SERVER.md`, `docs/AGENT_PROTOCOLS_GUIDE.md`, `docs/CLOUD_AGENT.md` -- **Routing & resilience**: `docs/AUTO-COMBO.md`, `docs/RESILIENCE_GUIDE.md` -- **Security**: `docs/AUTHZ_GUIDE.md`, `docs/GUARDRAILS.md`, `docs/COMPLIANCE.md`, `docs/STEALTH_GUIDE.md` -- **Extensibility**: `docs/SKILLS.md`, `docs/MEMORY.md`, `docs/EVALS.md`, `docs/WEBHOOKS.md`, `docs/REASONING_REPLAY.md` -- **Platform**: `docs/ELECTRON_GUIDE.md`, `docs/TUNNELS_GUIDE.md` +- **Architecture & Reference**: `docs/architecture/ARCHITECTURE.md`, `docs/architecture/CODEBASE_DOCUMENTATION.md`, `docs/architecture/REPOSITORY_MAP.md`, `docs/reference/API_REFERENCE.md`, `docs/reference/PROVIDER_REFERENCE.md`, `docs/reference/openapi.yaml` +- **Operator guides**: `docs/guides/USER_GUIDE.md`, `docs/reference/CLI-TOOLS.md`, `docs/guides/TROUBLESHOOTING.md`, `docs/ops/COVERAGE_PLAN.md` +- **Protocols**: `docs/frameworks/MCP-SERVER.md`, `docs/frameworks/A2A-SERVER.md`, `docs/frameworks/AGENT_PROTOCOLS_GUIDE.md`, `docs/frameworks/CLOUD_AGENT.md` +- **Routing & resilience**: `docs/routing/AUTO-COMBO.md`, `docs/architecture/RESILIENCE_GUIDE.md` +- **Security**: `docs/architecture/AUTHZ_GUIDE.md`, `docs/security/GUARDRAILS.md`, `docs/security/COMPLIANCE.md`, `docs/security/STEALTH_GUIDE.md` +- **Extensibility**: `docs/frameworks/SKILLS.md`, `docs/frameworks/MEMORY.md`, `docs/frameworks/EVALS.md`, `docs/frameworks/WEBHOOKS.md`, `docs/routing/REASONING_REPLAY.md` +- **Platform**: `docs/guides/ELECTRON_GUIDE.md`, `docs/ops/TUNNELS_GUIDE.md` - **AI agents**: `CLAUDE.md`, `AGENTS.md`, `GEMINI.md` diff --git a/docs/i18n/phi/CHANGELOG.md b/docs/i18n/phi/CHANGELOG.md index 9960f024ef..e1f5376827 100644 --- a/docs/i18n/phi/CHANGELOG.md +++ b/docs/i18n/phi/CHANGELOG.md @@ -1310,7 +1310,7 @@ We identified that **155 community PRs** across the entire project history (from - **33 New API Key Providers:** Massive provider expansion adding DeepInfra, Vercel AI Gateway, Lambda AI, SambaNova, nScale, OVHcloud AI, Baseten, PublicAI, Moonshot AI, Meta Llama API, v0 (Vercel), Morph, Featherless AI, FriendliAI, LlamaGate, Galadriel, Weights & Biases Inference, Volcengine, AI21 Labs, Venice.ai, Codestral, Upstage, Maritalk, Xiaomi MiMo, Inference.net, NanoGPT, Predibase, Bytez, Heroku AI, Databricks, Snowflake Cortex, and GigaChat (Sber). OmniRoute now supports **100+ providers** (4 Free + 8 OAuth + 91 API Key + Custom compatible) - **Global Email Privacy Toggle:** Added a persistent eye-icon toggle button across all dashboard pages (Providers, Usage Limits, Playground) that reveals or hides masked email addresses. Toggle state is stored in localStorage and synced globally via Zustand store - **Documentation Refresh:** Updated README, ARCHITECTURE, FEATURES, AGENTS.md, and API_REFERENCE for v3.6.2 with accurate provider counts (100+), new executor list, and system API documentation -- **Uninstall Guide:** Created comprehensive `docs/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) +- **Uninstall Guide:** Created comprehensive `docs/guides/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) ### 🐛 Bug Fixes diff --git a/docs/i18n/phi/CONTRIBUTING.md b/docs/i18n/phi/CONTRIBUTING.md index b776a35afb..e7de589cb4 100644 --- a/docs/i18n/phi/CONTRIBUTING.md +++ b/docs/i18n/phi/CONTRIBUTING.md @@ -153,7 +153,7 @@ Coverage notes: - If a PR changes production code in `src/`, `open-sse/`, `electron/`, or `bin/`, it must add or update automated tests in the same PR - `npm run coverage:report` prints the detailed file-by-file report from the latest coverage run - `npm run test:coverage:legacy` preserves the older metric for historical comparison -- See `docs/COVERAGE_PLAN.md` for the phased coverage improvement roadmap +- See `docs/ops/COVERAGE_PLAN.md` for the phased coverage improvement roadmap ### Pull Request Requirements @@ -305,7 +305,7 @@ Releases are managed via the `/generate-release` workflow. When a new GitHub Rel ## Getting Help -- **Architecture**: See [`docs/ARCHITECTURE.md`](docs/ARCHITECTURE.md) -- **API Reference**: See [`docs/API_REFERENCE.md`](docs/API_REFERENCE.md) +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](docs/architecture/ARCHITECTURE.md) +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](docs/reference/API_REFERENCE.md) - **Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) - **ADRs**: See `docs/adr/` for architectural decision records diff --git a/docs/i18n/phi/README.md b/docs/i18n/phi/README.md index b85c193aeb..82149249e4 100644 --- a/docs/i18n/phi/README.md +++ b/docs/i18n/phi/README.md @@ -2267,25 +2267,25 @@ Se não quiser criar credenciais próprias agora, ainda é possível usar o flux ## Dokumentasyon -| Document | Description | -| -------------------------------------------------------- | --------------------------------------------------- | -| [User Guide](docs/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | -| [API Reference](docs/API_REFERENCE.md) | All endpoints with examples | -| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | -| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | -| [Auto-Combo Engine](docs/AUTO-COMBO.md) | 6-factor scoring, mode packs, self-healing | -| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | -| [Troubleshooting](docs/TROUBLESHOOTING.md) | Common problems and solutions | -| [Architecture](docs/ARCHITECTURE.md) | System architecture and internals | -| [Codebase Documentation](docs/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | -| [Uninstall Guide](docs/UNINSTALL.md) | Clean removal for all install methods | -| [Environment Config](docs/ENVIRONMENT.md) | Complete `.env` variables and references | -| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | -| [OpenAPI Spec](docs/openapi.yaml) | OpenAPI 3.0 specification | -| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | -| [VM Deployment](docs/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | -| [Features Gallery](docs/FEATURES.md) | Visual dashboard tour with screenshots | -| [Release Checklist](docs/RELEASE_CHECKLIST.md) | Pre-release validation steps | +| Document | Description | +| --------------------------------------------------------------------- | --------------------------------------------------- | +| [User Guide](docs/guides/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | +| [API Reference](docs/reference/API_REFERENCE.md) | All endpoints with examples | +| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | +| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | +| [Auto-Combo Engine](docs/routing/AUTO-COMBO.md) | 6-factor scoring, mode packs, self-healing | +| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | +| [Troubleshooting](docs/guides/TROUBLESHOOTING.md) | Common problems and solutions | +| [Architecture](docs/architecture/ARCHITECTURE.md) | System architecture and internals | +| [Codebase Documentation](docs/architecture/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | +| [Uninstall Guide](docs/guides/UNINSTALL.md) | Clean removal for all install methods | +| [Environment Config](docs/reference/ENVIRONMENT.md) | Complete `.env` variables and references | +| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | +| [OpenAPI Spec](docs/reference/openapi.yaml) | OpenAPI 3.0 specification | +| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | +| [VM Deployment](docs/ops/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | +| [Features Gallery](docs/guides/FEATURES.md) | Visual dashboard tour with screenshots | +| [Release Checklist](docs/ops/RELEASE_CHECKLIST.md) | Pre-release validation steps | --- diff --git a/docs/i18n/phi/docs/ARCHITECTURE.md b/docs/i18n/phi/docs/architecture/ARCHITECTURE.md similarity index 100% rename from docs/i18n/phi/docs/ARCHITECTURE.md rename to docs/i18n/phi/docs/architecture/ARCHITECTURE.md diff --git a/docs/i18n/phi/docs/CODEBASE_DOCUMENTATION.md b/docs/i18n/phi/docs/architecture/CODEBASE_DOCUMENTATION.md similarity index 100% rename from docs/i18n/phi/docs/CODEBASE_DOCUMENTATION.md rename to docs/i18n/phi/docs/architecture/CODEBASE_DOCUMENTATION.md diff --git a/docs/i18n/phi/docs/A2A-SERVER.md b/docs/i18n/phi/docs/frameworks/A2A-SERVER.md similarity index 100% rename from docs/i18n/phi/docs/A2A-SERVER.md rename to docs/i18n/phi/docs/frameworks/A2A-SERVER.md diff --git a/docs/i18n/phi/docs/MCP-SERVER.md b/docs/i18n/phi/docs/frameworks/MCP-SERVER.md similarity index 100% rename from docs/i18n/phi/docs/MCP-SERVER.md rename to docs/i18n/phi/docs/frameworks/MCP-SERVER.md diff --git a/docs/i18n/phi/docs/FEATURES.md b/docs/i18n/phi/docs/guides/FEATURES.md similarity index 100% rename from docs/i18n/phi/docs/FEATURES.md rename to docs/i18n/phi/docs/guides/FEATURES.md diff --git a/docs/i18n/phi/docs/I18N.md b/docs/i18n/phi/docs/guides/I18N.md similarity index 99% rename from docs/i18n/phi/docs/I18N.md rename to docs/i18n/phi/docs/guides/I18N.md index fbd3ac9fd7..d65bd52e3e 100644 --- a/docs/i18n/phi/docs/I18N.md +++ b/docs/i18n/phi/docs/guides/I18N.md @@ -420,7 +420,7 @@ The generator originally used `code: "in"` (deprecated Google Translate code) fo ### `docs/i18n/README.md` Is Auto-Generated -The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/I18N.md` (this file) for hand-written documentation that should persist. +The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/guides/I18N.md` (this file) for hand-written documentation that should persist. ### External Untranslatable Keys List diff --git a/docs/i18n/phi/docs/TROUBLESHOOTING.md b/docs/i18n/phi/docs/guides/TROUBLESHOOTING.md similarity index 98% rename from docs/i18n/phi/docs/TROUBLESHOOTING.md rename to docs/i18n/phi/docs/guides/TROUBLESHOOTING.md index 48964c3a28..645dbd210d 100644 --- a/docs/i18n/phi/docs/TROUBLESHOOTING.md +++ b/docs/i18n/phi/docs/guides/TROUBLESHOOTING.md @@ -335,7 +335,7 @@ You can ignore this section if you do not run RAG or agent pipelines behind Omni ## Still Stuck? - **GitHub Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) -- **Architecture**: See [`docs/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details -- **API Reference**: See [`docs/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints - **Health Dashboard**: Check **Dashboard → Health** for real-time system status - **Translator**: Use **Dashboard → Translator** to debug format issues diff --git a/docs/i18n/phi/docs/UNINSTALL.md b/docs/i18n/phi/docs/guides/UNINSTALL.md similarity index 100% rename from docs/i18n/phi/docs/UNINSTALL.md rename to docs/i18n/phi/docs/guides/UNINSTALL.md diff --git a/docs/i18n/phi/docs/USER_GUIDE.md b/docs/i18n/phi/docs/guides/USER_GUIDE.md similarity index 100% rename from docs/i18n/phi/docs/USER_GUIDE.md rename to docs/i18n/phi/docs/guides/USER_GUIDE.md diff --git a/docs/i18n/phi/docs/COVERAGE_PLAN.md b/docs/i18n/phi/docs/ops/COVERAGE_PLAN.md similarity index 100% rename from docs/i18n/phi/docs/COVERAGE_PLAN.md rename to docs/i18n/phi/docs/ops/COVERAGE_PLAN.md diff --git a/docs/i18n/phi/docs/FLY_IO_DEPLOYMENT_GUIDE.md b/docs/i18n/phi/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/phi/docs/FLY_IO_DEPLOYMENT_GUIDE.md rename to docs/i18n/phi/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/phi/docs/RELEASE_CHECKLIST.md b/docs/i18n/phi/docs/ops/RELEASE_CHECKLIST.md similarity index 94% rename from docs/i18n/phi/docs/RELEASE_CHECKLIST.md rename to docs/i18n/phi/docs/ops/RELEASE_CHECKLIST.md index f480c3a133..da3b33e633 100644 --- a/docs/i18n/phi/docs/RELEASE_CHECKLIST.md +++ b/docs/i18n/phi/docs/ops/RELEASE_CHECKLIST.md @@ -16,14 +16,14 @@ Use this checklist before tagging or publishing a new OmniRoute release. ## API Docs -1. Update `docs/openapi.yaml`: +1. Update `docs/reference/openapi.yaml`: - `info.version` must equal `package.json` version. 2. Validate endpoint examples if API contracts changed. ## Runtime Docs -1. Review `docs/ARCHITECTURE.md` for storage/runtime drift. -2. Review `docs/TROUBLESHOOTING.md` for env var and operational drift. +1. Review `docs/architecture/ARCHITECTURE.md` for storage/runtime drift. +2. Review `docs/guides/TROUBLESHOOTING.md` for env var and operational drift. 3. Verify the release/runtime Node.js version still satisfies the supported secure floor: - `>=20.20.2 <21` or `>=22.22.2 <23` - `npm run check:node-runtime` diff --git a/docs/i18n/phi/docs/VM_DEPLOYMENT_GUIDE.md b/docs/i18n/phi/docs/ops/VM_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/phi/docs/VM_DEPLOYMENT_GUIDE.md rename to docs/i18n/phi/docs/ops/VM_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/phi/docs/API_REFERENCE.md b/docs/i18n/phi/docs/reference/API_REFERENCE.md similarity index 100% rename from docs/i18n/phi/docs/API_REFERENCE.md rename to docs/i18n/phi/docs/reference/API_REFERENCE.md diff --git a/docs/i18n/phi/docs/CLI-TOOLS.md b/docs/i18n/phi/docs/reference/CLI-TOOLS.md similarity index 100% rename from docs/i18n/phi/docs/CLI-TOOLS.md rename to docs/i18n/phi/docs/reference/CLI-TOOLS.md diff --git a/docs/i18n/phi/docs/ENVIRONMENT.md b/docs/i18n/phi/docs/reference/ENVIRONMENT.md similarity index 100% rename from docs/i18n/phi/docs/ENVIRONMENT.md rename to docs/i18n/phi/docs/reference/ENVIRONMENT.md diff --git a/docs/i18n/phi/docs/AUTO-COMBO.md b/docs/i18n/phi/docs/routing/AUTO-COMBO.md similarity index 100% rename from docs/i18n/phi/docs/AUTO-COMBO.md rename to docs/i18n/phi/docs/routing/AUTO-COMBO.md diff --git a/docs/i18n/phi/llm.txt b/docs/i18n/phi/llm.txt index 920c658f14..159e12a77e 100644 --- a/docs/i18n/phi/llm.txt +++ b/docs/i18n/phi/llm.txt @@ -357,11 +357,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### MCP Server (37 Tools) | Category | Tools | |------------|-------| -| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/MCP-SERVER.md` for full inventory) | +| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/frameworks/MCP-SERVER.md` for full inventory) | | Memory (3) | `memory_search`, `memory_add`, `memory_clear` | | Skills (4) | `skills_list`, `skills_enable`, `skills_execute`, `skills_executions` | -**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/MCP-SERVER.md`. +**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/frameworks/MCP-SERVER.md`. ### Provider Categories @@ -472,7 +472,7 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo 20. **Guardrails framework** in `src/lib/guardrails/` — hot-reloadable registry. Built-ins (priority-ordered): `vision-bridge` (5) → `pii-masker` (10) → `prompt-injection` (20). Fail-open model: exceptions never block traffic. Per-request opt-out via `x-omniroute-disabled-guardrails` header. -21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/AUTHZ_GUIDE.md`. +21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/architecture/AUTHZ_GUIDE.md`. 22. **Three resilience layers** are distinct (do not conflate them): - **Provider Circuit Breaker** (`src/shared/utils/circuitBreaker.ts`) — whole-provider scope. @@ -489,11 +489,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo - **MCP server expanded to 37 tools** (30 base + 3 memory + 4 skills) across ~13 scopes - **OAuth providers expanded to 14**: added Qwen, Kiro, Qoder, Gemini, Windsurf, GitLab Duo - **Coverage gate raised to 75/75/75/70** (was 60% across the board) — measured ~82% -- **Reasoning replay** (`docs/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams +- **Reasoning replay** (`docs/routing/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams - **Compliance + Evals + Webhooks** documentation introduced -- **Stealth guide** (`docs/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration -- **Tunnels guide** (`docs/TUNNELS_GUIDE.md`) — Cloudflare tunnel management -- **Electron guide** (`docs/ELECTRON_GUIDE.md`) — desktop app build + signing +- **Stealth guide** (`docs/security/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration +- **Tunnels guide** (`docs/ops/TUNNELS_GUIDE.md`) — Cloudflare tunnel management +- **Electron guide** (`docs/guides/ELECTRON_GUIDE.md`) — desktop app build + signing ## Links @@ -505,11 +505,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### Documentation Index -- **Architecture & Reference**: `docs/ARCHITECTURE.md`, `docs/CODEBASE_DOCUMENTATION.md`, `docs/REPOSITORY_MAP.md`, `docs/API_REFERENCE.md`, `docs/PROVIDER_REFERENCE.md`, `docs/openapi.yaml` -- **Operator guides**: `docs/USER_GUIDE.md`, `docs/CLI-TOOLS.md`, `docs/TROUBLESHOOTING.md`, `docs/COVERAGE_PLAN.md` -- **Protocols**: `docs/MCP-SERVER.md`, `docs/A2A-SERVER.md`, `docs/AGENT_PROTOCOLS_GUIDE.md`, `docs/CLOUD_AGENT.md` -- **Routing & resilience**: `docs/AUTO-COMBO.md`, `docs/RESILIENCE_GUIDE.md` -- **Security**: `docs/AUTHZ_GUIDE.md`, `docs/GUARDRAILS.md`, `docs/COMPLIANCE.md`, `docs/STEALTH_GUIDE.md` -- **Extensibility**: `docs/SKILLS.md`, `docs/MEMORY.md`, `docs/EVALS.md`, `docs/WEBHOOKS.md`, `docs/REASONING_REPLAY.md` -- **Platform**: `docs/ELECTRON_GUIDE.md`, `docs/TUNNELS_GUIDE.md` +- **Architecture & Reference**: `docs/architecture/ARCHITECTURE.md`, `docs/architecture/CODEBASE_DOCUMENTATION.md`, `docs/architecture/REPOSITORY_MAP.md`, `docs/reference/API_REFERENCE.md`, `docs/reference/PROVIDER_REFERENCE.md`, `docs/reference/openapi.yaml` +- **Operator guides**: `docs/guides/USER_GUIDE.md`, `docs/reference/CLI-TOOLS.md`, `docs/guides/TROUBLESHOOTING.md`, `docs/ops/COVERAGE_PLAN.md` +- **Protocols**: `docs/frameworks/MCP-SERVER.md`, `docs/frameworks/A2A-SERVER.md`, `docs/frameworks/AGENT_PROTOCOLS_GUIDE.md`, `docs/frameworks/CLOUD_AGENT.md` +- **Routing & resilience**: `docs/routing/AUTO-COMBO.md`, `docs/architecture/RESILIENCE_GUIDE.md` +- **Security**: `docs/architecture/AUTHZ_GUIDE.md`, `docs/security/GUARDRAILS.md`, `docs/security/COMPLIANCE.md`, `docs/security/STEALTH_GUIDE.md` +- **Extensibility**: `docs/frameworks/SKILLS.md`, `docs/frameworks/MEMORY.md`, `docs/frameworks/EVALS.md`, `docs/frameworks/WEBHOOKS.md`, `docs/routing/REASONING_REPLAY.md` +- **Platform**: `docs/guides/ELECTRON_GUIDE.md`, `docs/ops/TUNNELS_GUIDE.md` - **AI agents**: `CLAUDE.md`, `AGENTS.md`, `GEMINI.md` diff --git a/docs/i18n/pl/CHANGELOG.md b/docs/i18n/pl/CHANGELOG.md index b6891cc7f8..95c895bb31 100644 --- a/docs/i18n/pl/CHANGELOG.md +++ b/docs/i18n/pl/CHANGELOG.md @@ -1310,7 +1310,7 @@ We identified that **155 community PRs** across the entire project history (from - **33 New API Key Providers:** Massive provider expansion adding DeepInfra, Vercel AI Gateway, Lambda AI, SambaNova, nScale, OVHcloud AI, Baseten, PublicAI, Moonshot AI, Meta Llama API, v0 (Vercel), Morph, Featherless AI, FriendliAI, LlamaGate, Galadriel, Weights & Biases Inference, Volcengine, AI21 Labs, Venice.ai, Codestral, Upstage, Maritalk, Xiaomi MiMo, Inference.net, NanoGPT, Predibase, Bytez, Heroku AI, Databricks, Snowflake Cortex, and GigaChat (Sber). OmniRoute now supports **100+ providers** (4 Free + 8 OAuth + 91 API Key + Custom compatible) - **Global Email Privacy Toggle:** Added a persistent eye-icon toggle button across all dashboard pages (Providers, Usage Limits, Playground) that reveals or hides masked email addresses. Toggle state is stored in localStorage and synced globally via Zustand store - **Documentation Refresh:** Updated README, ARCHITECTURE, FEATURES, AGENTS.md, and API_REFERENCE for v3.6.2 with accurate provider counts (100+), new executor list, and system API documentation -- **Uninstall Guide:** Created comprehensive `docs/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) +- **Uninstall Guide:** Created comprehensive `docs/guides/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) ### 🐛 Bug Fixes diff --git a/docs/i18n/pl/CONTRIBUTING.md b/docs/i18n/pl/CONTRIBUTING.md index 6645c79b33..5522097225 100644 --- a/docs/i18n/pl/CONTRIBUTING.md +++ b/docs/i18n/pl/CONTRIBUTING.md @@ -153,7 +153,7 @@ Coverage notes: - If a PR changes production code in `src/`, `open-sse/`, `electron/`, or `bin/`, it must add or update automated tests in the same PR - `npm run coverage:report` prints the detailed file-by-file report from the latest coverage run - `npm run test:coverage:legacy` preserves the older metric for historical comparison -- See `docs/COVERAGE_PLAN.md` for the phased coverage improvement roadmap +- See `docs/ops/COVERAGE_PLAN.md` for the phased coverage improvement roadmap ### Pull Request Requirements @@ -305,7 +305,7 @@ Releases are managed via the `/generate-release` workflow. When a new GitHub Rel ## Getting Help -- **Architecture**: See [`docs/ARCHITECTURE.md`](docs/ARCHITECTURE.md) -- **API Reference**: See [`docs/API_REFERENCE.md`](docs/API_REFERENCE.md) +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](docs/architecture/ARCHITECTURE.md) +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](docs/reference/API_REFERENCE.md) - **Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) - **ADRs**: See `docs/adr/` for architectural decision records diff --git a/docs/i18n/pl/README.md b/docs/i18n/pl/README.md index 06a6f3c00e..37bcec15fa 100644 --- a/docs/i18n/pl/README.md +++ b/docs/i18n/pl/README.md @@ -2267,25 +2267,25 @@ Se não quiser criar credenciais próprias agora, ainda é possível usar o flux ## Dokumentacja -| Document | Description | -| -------------------------------------------------------- | --------------------------------------------------- | -| [User Guide](docs/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | -| [API Reference](docs/API_REFERENCE.md) | All endpoints with examples | -| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | -| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | -| [Auto-Combo Engine](docs/AUTO-COMBO.md) | 6-factor scoring, mode packs, self-healing | -| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | -| [Troubleshooting](docs/TROUBLESHOOTING.md) | Common problems and solutions | -| [Architecture](docs/ARCHITECTURE.md) | System architecture and internals | -| [Codebase Documentation](docs/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | -| [Uninstall Guide](docs/UNINSTALL.md) | Clean removal for all install methods | -| [Environment Config](docs/ENVIRONMENT.md) | Complete `.env` variables and references | -| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | -| [OpenAPI Spec](docs/openapi.yaml) | OpenAPI 3.0 specification | -| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | -| [VM Deployment](docs/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | -| [Features Gallery](docs/FEATURES.md) | Visual dashboard tour with screenshots | -| [Release Checklist](docs/RELEASE_CHECKLIST.md) | Pre-release validation steps | +| Document | Description | +| --------------------------------------------------------------------- | --------------------------------------------------- | +| [User Guide](docs/guides/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | +| [API Reference](docs/reference/API_REFERENCE.md) | All endpoints with examples | +| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | +| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | +| [Auto-Combo Engine](docs/routing/AUTO-COMBO.md) | 6-factor scoring, mode packs, self-healing | +| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | +| [Troubleshooting](docs/guides/TROUBLESHOOTING.md) | Common problems and solutions | +| [Architecture](docs/architecture/ARCHITECTURE.md) | System architecture and internals | +| [Codebase Documentation](docs/architecture/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | +| [Uninstall Guide](docs/guides/UNINSTALL.md) | Clean removal for all install methods | +| [Environment Config](docs/reference/ENVIRONMENT.md) | Complete `.env` variables and references | +| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | +| [OpenAPI Spec](docs/reference/openapi.yaml) | OpenAPI 3.0 specification | +| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | +| [VM Deployment](docs/ops/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | +| [Features Gallery](docs/guides/FEATURES.md) | Visual dashboard tour with screenshots | +| [Release Checklist](docs/ops/RELEASE_CHECKLIST.md) | Pre-release validation steps | --- diff --git a/docs/i18n/pl/docs/ARCHITECTURE.md b/docs/i18n/pl/docs/architecture/ARCHITECTURE.md similarity index 100% rename from docs/i18n/pl/docs/ARCHITECTURE.md rename to docs/i18n/pl/docs/architecture/ARCHITECTURE.md diff --git a/docs/i18n/pl/docs/CODEBASE_DOCUMENTATION.md b/docs/i18n/pl/docs/architecture/CODEBASE_DOCUMENTATION.md similarity index 100% rename from docs/i18n/pl/docs/CODEBASE_DOCUMENTATION.md rename to docs/i18n/pl/docs/architecture/CODEBASE_DOCUMENTATION.md diff --git a/docs/i18n/pl/docs/A2A-SERVER.md b/docs/i18n/pl/docs/frameworks/A2A-SERVER.md similarity index 100% rename from docs/i18n/pl/docs/A2A-SERVER.md rename to docs/i18n/pl/docs/frameworks/A2A-SERVER.md diff --git a/docs/i18n/pl/docs/MCP-SERVER.md b/docs/i18n/pl/docs/frameworks/MCP-SERVER.md similarity index 100% rename from docs/i18n/pl/docs/MCP-SERVER.md rename to docs/i18n/pl/docs/frameworks/MCP-SERVER.md diff --git a/docs/i18n/pl/docs/FEATURES.md b/docs/i18n/pl/docs/guides/FEATURES.md similarity index 100% rename from docs/i18n/pl/docs/FEATURES.md rename to docs/i18n/pl/docs/guides/FEATURES.md diff --git a/docs/i18n/pl/docs/I18N.md b/docs/i18n/pl/docs/guides/I18N.md similarity index 99% rename from docs/i18n/pl/docs/I18N.md rename to docs/i18n/pl/docs/guides/I18N.md index 50b29f62a9..fed5b2efc9 100644 --- a/docs/i18n/pl/docs/I18N.md +++ b/docs/i18n/pl/docs/guides/I18N.md @@ -420,7 +420,7 @@ The generator originally used `code: "in"` (deprecated Google Translate code) fo ### `docs/i18n/README.md` Is Auto-Generated -The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/I18N.md` (this file) for hand-written documentation that should persist. +The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/guides/I18N.md` (this file) for hand-written documentation that should persist. ### External Untranslatable Keys List diff --git a/docs/i18n/pl/docs/TROUBLESHOOTING.md b/docs/i18n/pl/docs/guides/TROUBLESHOOTING.md similarity index 98% rename from docs/i18n/pl/docs/TROUBLESHOOTING.md rename to docs/i18n/pl/docs/guides/TROUBLESHOOTING.md index 602fb51932..03529c71ed 100644 --- a/docs/i18n/pl/docs/TROUBLESHOOTING.md +++ b/docs/i18n/pl/docs/guides/TROUBLESHOOTING.md @@ -335,7 +335,7 @@ You can ignore this section if you do not run RAG or agent pipelines behind Omni ## Still Stuck? - **GitHub Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) -- **Architecture**: See [`docs/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details -- **API Reference**: See [`docs/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints - **Health Dashboard**: Check **Dashboard → Health** for real-time system status - **Translator**: Use **Dashboard → Translator** to debug format issues diff --git a/docs/i18n/pl/docs/UNINSTALL.md b/docs/i18n/pl/docs/guides/UNINSTALL.md similarity index 100% rename from docs/i18n/pl/docs/UNINSTALL.md rename to docs/i18n/pl/docs/guides/UNINSTALL.md diff --git a/docs/i18n/pl/docs/USER_GUIDE.md b/docs/i18n/pl/docs/guides/USER_GUIDE.md similarity index 100% rename from docs/i18n/pl/docs/USER_GUIDE.md rename to docs/i18n/pl/docs/guides/USER_GUIDE.md diff --git a/docs/i18n/pl/docs/COVERAGE_PLAN.md b/docs/i18n/pl/docs/ops/COVERAGE_PLAN.md similarity index 100% rename from docs/i18n/pl/docs/COVERAGE_PLAN.md rename to docs/i18n/pl/docs/ops/COVERAGE_PLAN.md diff --git a/docs/i18n/pl/docs/FLY_IO_DEPLOYMENT_GUIDE.md b/docs/i18n/pl/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/pl/docs/FLY_IO_DEPLOYMENT_GUIDE.md rename to docs/i18n/pl/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/pl/docs/RELEASE_CHECKLIST.md b/docs/i18n/pl/docs/ops/RELEASE_CHECKLIST.md similarity index 94% rename from docs/i18n/pl/docs/RELEASE_CHECKLIST.md rename to docs/i18n/pl/docs/ops/RELEASE_CHECKLIST.md index b170aa3341..26fb590869 100644 --- a/docs/i18n/pl/docs/RELEASE_CHECKLIST.md +++ b/docs/i18n/pl/docs/ops/RELEASE_CHECKLIST.md @@ -16,14 +16,14 @@ Use this checklist before tagging or publishing a new OmniRoute release. ## API Docs -1. Update `docs/openapi.yaml`: +1. Update `docs/reference/openapi.yaml`: - `info.version` must equal `package.json` version. 2. Validate endpoint examples if API contracts changed. ## Runtime Docs -1. Review `docs/ARCHITECTURE.md` for storage/runtime drift. -2. Review `docs/TROUBLESHOOTING.md` for env var and operational drift. +1. Review `docs/architecture/ARCHITECTURE.md` for storage/runtime drift. +2. Review `docs/guides/TROUBLESHOOTING.md` for env var and operational drift. 3. Verify the release/runtime Node.js version still satisfies the supported secure floor: - `>=20.20.2 <21` or `>=22.22.2 <23` - `npm run check:node-runtime` diff --git a/docs/i18n/pl/docs/VM_DEPLOYMENT_GUIDE.md b/docs/i18n/pl/docs/ops/VM_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/pl/docs/VM_DEPLOYMENT_GUIDE.md rename to docs/i18n/pl/docs/ops/VM_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/pl/docs/API_REFERENCE.md b/docs/i18n/pl/docs/reference/API_REFERENCE.md similarity index 100% rename from docs/i18n/pl/docs/API_REFERENCE.md rename to docs/i18n/pl/docs/reference/API_REFERENCE.md diff --git a/docs/i18n/pl/docs/CLI-TOOLS.md b/docs/i18n/pl/docs/reference/CLI-TOOLS.md similarity index 100% rename from docs/i18n/pl/docs/CLI-TOOLS.md rename to docs/i18n/pl/docs/reference/CLI-TOOLS.md diff --git a/docs/i18n/pl/docs/ENVIRONMENT.md b/docs/i18n/pl/docs/reference/ENVIRONMENT.md similarity index 100% rename from docs/i18n/pl/docs/ENVIRONMENT.md rename to docs/i18n/pl/docs/reference/ENVIRONMENT.md diff --git a/docs/i18n/pl/docs/AUTO-COMBO.md b/docs/i18n/pl/docs/routing/AUTO-COMBO.md similarity index 100% rename from docs/i18n/pl/docs/AUTO-COMBO.md rename to docs/i18n/pl/docs/routing/AUTO-COMBO.md diff --git a/docs/i18n/pl/llm.txt b/docs/i18n/pl/llm.txt index bc6d82e0c3..80d86112b4 100644 --- a/docs/i18n/pl/llm.txt +++ b/docs/i18n/pl/llm.txt @@ -357,11 +357,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### MCP Server (37 Tools) | Category | Tools | |------------|-------| -| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/MCP-SERVER.md` for full inventory) | +| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/frameworks/MCP-SERVER.md` for full inventory) | | Memory (3) | `memory_search`, `memory_add`, `memory_clear` | | Skills (4) | `skills_list`, `skills_enable`, `skills_execute`, `skills_executions` | -**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/MCP-SERVER.md`. +**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/frameworks/MCP-SERVER.md`. ### Provider Categories @@ -472,7 +472,7 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo 20. **Guardrails framework** in `src/lib/guardrails/` — hot-reloadable registry. Built-ins (priority-ordered): `vision-bridge` (5) → `pii-masker` (10) → `prompt-injection` (20). Fail-open model: exceptions never block traffic. Per-request opt-out via `x-omniroute-disabled-guardrails` header. -21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/AUTHZ_GUIDE.md`. +21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/architecture/AUTHZ_GUIDE.md`. 22. **Three resilience layers** are distinct (do not conflate them): - **Provider Circuit Breaker** (`src/shared/utils/circuitBreaker.ts`) — whole-provider scope. @@ -489,11 +489,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo - **MCP server expanded to 37 tools** (30 base + 3 memory + 4 skills) across ~13 scopes - **OAuth providers expanded to 14**: added Qwen, Kiro, Qoder, Gemini, Windsurf, GitLab Duo - **Coverage gate raised to 75/75/75/70** (was 60% across the board) — measured ~82% -- **Reasoning replay** (`docs/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams +- **Reasoning replay** (`docs/routing/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams - **Compliance + Evals + Webhooks** documentation introduced -- **Stealth guide** (`docs/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration -- **Tunnels guide** (`docs/TUNNELS_GUIDE.md`) — Cloudflare tunnel management -- **Electron guide** (`docs/ELECTRON_GUIDE.md`) — desktop app build + signing +- **Stealth guide** (`docs/security/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration +- **Tunnels guide** (`docs/ops/TUNNELS_GUIDE.md`) — Cloudflare tunnel management +- **Electron guide** (`docs/guides/ELECTRON_GUIDE.md`) — desktop app build + signing ## Links @@ -505,11 +505,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### Documentation Index -- **Architecture & Reference**: `docs/ARCHITECTURE.md`, `docs/CODEBASE_DOCUMENTATION.md`, `docs/REPOSITORY_MAP.md`, `docs/API_REFERENCE.md`, `docs/PROVIDER_REFERENCE.md`, `docs/openapi.yaml` -- **Operator guides**: `docs/USER_GUIDE.md`, `docs/CLI-TOOLS.md`, `docs/TROUBLESHOOTING.md`, `docs/COVERAGE_PLAN.md` -- **Protocols**: `docs/MCP-SERVER.md`, `docs/A2A-SERVER.md`, `docs/AGENT_PROTOCOLS_GUIDE.md`, `docs/CLOUD_AGENT.md` -- **Routing & resilience**: `docs/AUTO-COMBO.md`, `docs/RESILIENCE_GUIDE.md` -- **Security**: `docs/AUTHZ_GUIDE.md`, `docs/GUARDRAILS.md`, `docs/COMPLIANCE.md`, `docs/STEALTH_GUIDE.md` -- **Extensibility**: `docs/SKILLS.md`, `docs/MEMORY.md`, `docs/EVALS.md`, `docs/WEBHOOKS.md`, `docs/REASONING_REPLAY.md` -- **Platform**: `docs/ELECTRON_GUIDE.md`, `docs/TUNNELS_GUIDE.md` +- **Architecture & Reference**: `docs/architecture/ARCHITECTURE.md`, `docs/architecture/CODEBASE_DOCUMENTATION.md`, `docs/architecture/REPOSITORY_MAP.md`, `docs/reference/API_REFERENCE.md`, `docs/reference/PROVIDER_REFERENCE.md`, `docs/reference/openapi.yaml` +- **Operator guides**: `docs/guides/USER_GUIDE.md`, `docs/reference/CLI-TOOLS.md`, `docs/guides/TROUBLESHOOTING.md`, `docs/ops/COVERAGE_PLAN.md` +- **Protocols**: `docs/frameworks/MCP-SERVER.md`, `docs/frameworks/A2A-SERVER.md`, `docs/frameworks/AGENT_PROTOCOLS_GUIDE.md`, `docs/frameworks/CLOUD_AGENT.md` +- **Routing & resilience**: `docs/routing/AUTO-COMBO.md`, `docs/architecture/RESILIENCE_GUIDE.md` +- **Security**: `docs/architecture/AUTHZ_GUIDE.md`, `docs/security/GUARDRAILS.md`, `docs/security/COMPLIANCE.md`, `docs/security/STEALTH_GUIDE.md` +- **Extensibility**: `docs/frameworks/SKILLS.md`, `docs/frameworks/MEMORY.md`, `docs/frameworks/EVALS.md`, `docs/frameworks/WEBHOOKS.md`, `docs/routing/REASONING_REPLAY.md` +- **Platform**: `docs/guides/ELECTRON_GUIDE.md`, `docs/ops/TUNNELS_GUIDE.md` - **AI agents**: `CLAUDE.md`, `AGENTS.md`, `GEMINI.md` diff --git a/docs/i18n/pt-BR/CHANGELOG.md b/docs/i18n/pt-BR/CHANGELOG.md index 03722be51a..0b95df31f5 100644 --- a/docs/i18n/pt-BR/CHANGELOG.md +++ b/docs/i18n/pt-BR/CHANGELOG.md @@ -1310,7 +1310,7 @@ We identified that **155 community PRs** across the entire project history (from - **33 New API Key Providers:** Massive provider expansion adding DeepInfra, Vercel AI Gateway, Lambda AI, SambaNova, nScale, OVHcloud AI, Baseten, PublicAI, Moonshot AI, Meta Llama API, v0 (Vercel), Morph, Featherless AI, FriendliAI, LlamaGate, Galadriel, Weights & Biases Inference, Volcengine, AI21 Labs, Venice.ai, Codestral, Upstage, Maritalk, Xiaomi MiMo, Inference.net, NanoGPT, Predibase, Bytez, Heroku AI, Databricks, Snowflake Cortex, and GigaChat (Sber). OmniRoute now supports **100+ providers** (4 Free + 8 OAuth + 91 API Key + Custom compatible) - **Global Email Privacy Toggle:** Added a persistent eye-icon toggle button across all dashboard pages (Providers, Usage Limits, Playground) that reveals or hides masked email addresses. Toggle state is stored in localStorage and synced globally via Zustand store - **Documentation Refresh:** Updated README, ARCHITECTURE, FEATURES, AGENTS.md, and API_REFERENCE for v3.6.2 with accurate provider counts (100+), new executor list, and system API documentation -- **Uninstall Guide:** Created comprehensive `docs/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) +- **Uninstall Guide:** Created comprehensive `docs/guides/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) ### 🐛 Bug Fixes diff --git a/docs/i18n/pt-BR/CONTRIBUTING.md b/docs/i18n/pt-BR/CONTRIBUTING.md index 675d966ac9..edb8c7bd71 100644 --- a/docs/i18n/pt-BR/CONTRIBUTING.md +++ b/docs/i18n/pt-BR/CONTRIBUTING.md @@ -153,7 +153,7 @@ Coverage notes: - If a PR changes production code in `src/`, `open-sse/`, `electron/`, or `bin/`, it must add or update automated tests in the same PR - `npm run coverage:report` prints the detailed file-by-file report from the latest coverage run - `npm run test:coverage:legacy` preserves the older metric for historical comparison -- See `docs/COVERAGE_PLAN.md` for the phased coverage improvement roadmap +- See `docs/ops/COVERAGE_PLAN.md` for the phased coverage improvement roadmap ### Pull Request Requirements @@ -305,7 +305,7 @@ Releases are managed via the `/generate-release` workflow. When a new GitHub Rel ## Getting Help -- **Architecture**: See [`docs/ARCHITECTURE.md`](docs/ARCHITECTURE.md) -- **API Reference**: See [`docs/API_REFERENCE.md`](docs/API_REFERENCE.md) +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](docs/architecture/ARCHITECTURE.md) +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](docs/reference/API_REFERENCE.md) - **Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) - **ADRs**: See `docs/adr/` for architectural decision records diff --git a/docs/i18n/pt-BR/README.md b/docs/i18n/pt-BR/README.md index 1c31271e86..77e48d0334 100644 --- a/docs/i18n/pt-BR/README.md +++ b/docs/i18n/pt-BR/README.md @@ -2267,25 +2267,25 @@ Se não quiser criar credenciais próprias agora, ainda é possível usar o flux ## Documentação -| Document | Description | -| -------------------------------------------------------- | --------------------------------------------------- | -| [User Guide](docs/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | -| [API Reference](docs/API_REFERENCE.md) | All endpoints with examples | -| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | -| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | -| [Auto-Combo Engine](docs/AUTO-COMBO.md) | 6-factor scoring, mode packs, self-healing | -| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | -| [Troubleshooting](docs/TROUBLESHOOTING.md) | Common problems and solutions | -| [Architecture](docs/ARCHITECTURE.md) | System architecture and internals | -| [Codebase Documentation](docs/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | -| [Uninstall Guide](docs/UNINSTALL.md) | Clean removal for all install methods | -| [Environment Config](docs/ENVIRONMENT.md) | Complete `.env` variables and references | -| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | -| [OpenAPI Spec](docs/openapi.yaml) | OpenAPI 3.0 specification | -| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | -| [VM Deployment](docs/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | -| [Features Gallery](docs/FEATURES.md) | Visual dashboard tour with screenshots | -| [Release Checklist](docs/RELEASE_CHECKLIST.md) | Pre-release validation steps | +| Document | Description | +| --------------------------------------------------------------------- | --------------------------------------------------- | +| [User Guide](docs/guides/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | +| [API Reference](docs/reference/API_REFERENCE.md) | All endpoints with examples | +| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | +| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | +| [Auto-Combo Engine](docs/routing/AUTO-COMBO.md) | 6-factor scoring, mode packs, self-healing | +| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | +| [Troubleshooting](docs/guides/TROUBLESHOOTING.md) | Common problems and solutions | +| [Architecture](docs/architecture/ARCHITECTURE.md) | System architecture and internals | +| [Codebase Documentation](docs/architecture/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | +| [Uninstall Guide](docs/guides/UNINSTALL.md) | Clean removal for all install methods | +| [Environment Config](docs/reference/ENVIRONMENT.md) | Complete `.env` variables and references | +| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | +| [OpenAPI Spec](docs/reference/openapi.yaml) | OpenAPI 3.0 specification | +| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | +| [VM Deployment](docs/ops/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | +| [Features Gallery](docs/guides/FEATURES.md) | Visual dashboard tour with screenshots | +| [Release Checklist](docs/ops/RELEASE_CHECKLIST.md) | Pre-release validation steps | --- diff --git a/docs/i18n/pt-BR/docs/ARCHITECTURE.md b/docs/i18n/pt-BR/docs/architecture/ARCHITECTURE.md similarity index 100% rename from docs/i18n/pt-BR/docs/ARCHITECTURE.md rename to docs/i18n/pt-BR/docs/architecture/ARCHITECTURE.md diff --git a/docs/i18n/pt-BR/docs/CODEBASE_DOCUMENTATION.md b/docs/i18n/pt-BR/docs/architecture/CODEBASE_DOCUMENTATION.md similarity index 100% rename from docs/i18n/pt-BR/docs/CODEBASE_DOCUMENTATION.md rename to docs/i18n/pt-BR/docs/architecture/CODEBASE_DOCUMENTATION.md diff --git a/docs/i18n/pt-BR/docs/A2A-SERVER.md b/docs/i18n/pt-BR/docs/frameworks/A2A-SERVER.md similarity index 100% rename from docs/i18n/pt-BR/docs/A2A-SERVER.md rename to docs/i18n/pt-BR/docs/frameworks/A2A-SERVER.md diff --git a/docs/i18n/pt-BR/docs/MCP-SERVER.md b/docs/i18n/pt-BR/docs/frameworks/MCP-SERVER.md similarity index 100% rename from docs/i18n/pt-BR/docs/MCP-SERVER.md rename to docs/i18n/pt-BR/docs/frameworks/MCP-SERVER.md diff --git a/docs/i18n/pt-BR/docs/FEATURES.md b/docs/i18n/pt-BR/docs/guides/FEATURES.md similarity index 100% rename from docs/i18n/pt-BR/docs/FEATURES.md rename to docs/i18n/pt-BR/docs/guides/FEATURES.md diff --git a/docs/i18n/pt-BR/docs/I18N.md b/docs/i18n/pt-BR/docs/guides/I18N.md similarity index 99% rename from docs/i18n/pt-BR/docs/I18N.md rename to docs/i18n/pt-BR/docs/guides/I18N.md index 2faef1c2c4..4c31b74476 100644 --- a/docs/i18n/pt-BR/docs/I18N.md +++ b/docs/i18n/pt-BR/docs/guides/I18N.md @@ -420,7 +420,7 @@ The generator originally used `code: "in"` (deprecated Google Translate code) fo ### `docs/i18n/README.md` Is Auto-Generated -The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/I18N.md` (this file) for hand-written documentation that should persist. +The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/guides/I18N.md` (this file) for hand-written documentation that should persist. ### External Untranslatable Keys List diff --git a/docs/i18n/pt-BR/docs/TROUBLESHOOTING.md b/docs/i18n/pt-BR/docs/guides/TROUBLESHOOTING.md similarity index 98% rename from docs/i18n/pt-BR/docs/TROUBLESHOOTING.md rename to docs/i18n/pt-BR/docs/guides/TROUBLESHOOTING.md index 6392bd7189..f951053005 100644 --- a/docs/i18n/pt-BR/docs/TROUBLESHOOTING.md +++ b/docs/i18n/pt-BR/docs/guides/TROUBLESHOOTING.md @@ -335,7 +335,7 @@ You can ignore this section if you do not run RAG or agent pipelines behind Omni ## Still Stuck? - **GitHub Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) -- **Architecture**: See [`docs/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details -- **API Reference**: See [`docs/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints - **Health Dashboard**: Check **Dashboard → Health** for real-time system status - **Translator**: Use **Dashboard → Translator** to debug format issues diff --git a/docs/i18n/pt-BR/docs/UNINSTALL.md b/docs/i18n/pt-BR/docs/guides/UNINSTALL.md similarity index 100% rename from docs/i18n/pt-BR/docs/UNINSTALL.md rename to docs/i18n/pt-BR/docs/guides/UNINSTALL.md diff --git a/docs/i18n/pt-BR/docs/USER_GUIDE.md b/docs/i18n/pt-BR/docs/guides/USER_GUIDE.md similarity index 100% rename from docs/i18n/pt-BR/docs/USER_GUIDE.md rename to docs/i18n/pt-BR/docs/guides/USER_GUIDE.md diff --git a/docs/i18n/pt-BR/docs/COVERAGE_PLAN.md b/docs/i18n/pt-BR/docs/ops/COVERAGE_PLAN.md similarity index 100% rename from docs/i18n/pt-BR/docs/COVERAGE_PLAN.md rename to docs/i18n/pt-BR/docs/ops/COVERAGE_PLAN.md diff --git a/docs/i18n/pt-BR/docs/FLY_IO_DEPLOYMENT_GUIDE.md b/docs/i18n/pt-BR/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/pt-BR/docs/FLY_IO_DEPLOYMENT_GUIDE.md rename to docs/i18n/pt-BR/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/pt-BR/docs/RELEASE_CHECKLIST.md b/docs/i18n/pt-BR/docs/ops/RELEASE_CHECKLIST.md similarity index 94% rename from docs/i18n/pt-BR/docs/RELEASE_CHECKLIST.md rename to docs/i18n/pt-BR/docs/ops/RELEASE_CHECKLIST.md index 61a72634a5..8154882016 100644 --- a/docs/i18n/pt-BR/docs/RELEASE_CHECKLIST.md +++ b/docs/i18n/pt-BR/docs/ops/RELEASE_CHECKLIST.md @@ -16,14 +16,14 @@ Use this checklist before tagging or publishing a new OmniRoute release. ## API Docs -1. Update `docs/openapi.yaml`: +1. Update `docs/reference/openapi.yaml`: - `info.version` must equal `package.json` version. 2. Validate endpoint examples if API contracts changed. ## Runtime Docs -1. Review `docs/ARCHITECTURE.md` for storage/runtime drift. -2. Review `docs/TROUBLESHOOTING.md` for env var and operational drift. +1. Review `docs/architecture/ARCHITECTURE.md` for storage/runtime drift. +2. Review `docs/guides/TROUBLESHOOTING.md` for env var and operational drift. 3. Verify the release/runtime Node.js version still satisfies the supported secure floor: - `>=20.20.2 <21` or `>=22.22.2 <23` - `npm run check:node-runtime` diff --git a/docs/i18n/pt-BR/docs/VM_DEPLOYMENT_GUIDE.md b/docs/i18n/pt-BR/docs/ops/VM_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/pt-BR/docs/VM_DEPLOYMENT_GUIDE.md rename to docs/i18n/pt-BR/docs/ops/VM_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/pt-BR/docs/API_REFERENCE.md b/docs/i18n/pt-BR/docs/reference/API_REFERENCE.md similarity index 100% rename from docs/i18n/pt-BR/docs/API_REFERENCE.md rename to docs/i18n/pt-BR/docs/reference/API_REFERENCE.md diff --git a/docs/i18n/pt-BR/docs/CLI-TOOLS.md b/docs/i18n/pt-BR/docs/reference/CLI-TOOLS.md similarity index 100% rename from docs/i18n/pt-BR/docs/CLI-TOOLS.md rename to docs/i18n/pt-BR/docs/reference/CLI-TOOLS.md diff --git a/docs/i18n/pt-BR/docs/ENVIRONMENT.md b/docs/i18n/pt-BR/docs/reference/ENVIRONMENT.md similarity index 100% rename from docs/i18n/pt-BR/docs/ENVIRONMENT.md rename to docs/i18n/pt-BR/docs/reference/ENVIRONMENT.md diff --git a/docs/i18n/pt-BR/docs/AUTO-COMBO.md b/docs/i18n/pt-BR/docs/routing/AUTO-COMBO.md similarity index 100% rename from docs/i18n/pt-BR/docs/AUTO-COMBO.md rename to docs/i18n/pt-BR/docs/routing/AUTO-COMBO.md diff --git a/docs/i18n/pt-BR/llm.txt b/docs/i18n/pt-BR/llm.txt index d2de5e8572..632fc7135f 100644 --- a/docs/i18n/pt-BR/llm.txt +++ b/docs/i18n/pt-BR/llm.txt @@ -357,11 +357,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### MCP Server (37 Tools) | Category | Tools | |------------|-------| -| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/MCP-SERVER.md` for full inventory) | +| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/frameworks/MCP-SERVER.md` for full inventory) | | Memory (3) | `memory_search`, `memory_add`, `memory_clear` | | Skills (4) | `skills_list`, `skills_enable`, `skills_execute`, `skills_executions` | -**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/MCP-SERVER.md`. +**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/frameworks/MCP-SERVER.md`. ### Provider Categories @@ -472,7 +472,7 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo 20. **Guardrails framework** in `src/lib/guardrails/` — hot-reloadable registry. Built-ins (priority-ordered): `vision-bridge` (5) → `pii-masker` (10) → `prompt-injection` (20). Fail-open model: exceptions never block traffic. Per-request opt-out via `x-omniroute-disabled-guardrails` header. -21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/AUTHZ_GUIDE.md`. +21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/architecture/AUTHZ_GUIDE.md`. 22. **Three resilience layers** are distinct (do not conflate them): - **Provider Circuit Breaker** (`src/shared/utils/circuitBreaker.ts`) — whole-provider scope. @@ -489,11 +489,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo - **MCP server expanded to 37 tools** (30 base + 3 memory + 4 skills) across ~13 scopes - **OAuth providers expanded to 14**: added Qwen, Kiro, Qoder, Gemini, Windsurf, GitLab Duo - **Coverage gate raised to 75/75/75/70** (was 60% across the board) — measured ~82% -- **Reasoning replay** (`docs/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams +- **Reasoning replay** (`docs/routing/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams - **Compliance + Evals + Webhooks** documentation introduced -- **Stealth guide** (`docs/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration -- **Tunnels guide** (`docs/TUNNELS_GUIDE.md`) — Cloudflare tunnel management -- **Electron guide** (`docs/ELECTRON_GUIDE.md`) — desktop app build + signing +- **Stealth guide** (`docs/security/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration +- **Tunnels guide** (`docs/ops/TUNNELS_GUIDE.md`) — Cloudflare tunnel management +- **Electron guide** (`docs/guides/ELECTRON_GUIDE.md`) — desktop app build + signing ## Links @@ -505,11 +505,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### Documentation Index -- **Architecture & Reference**: `docs/ARCHITECTURE.md`, `docs/CODEBASE_DOCUMENTATION.md`, `docs/REPOSITORY_MAP.md`, `docs/API_REFERENCE.md`, `docs/PROVIDER_REFERENCE.md`, `docs/openapi.yaml` -- **Operator guides**: `docs/USER_GUIDE.md`, `docs/CLI-TOOLS.md`, `docs/TROUBLESHOOTING.md`, `docs/COVERAGE_PLAN.md` -- **Protocols**: `docs/MCP-SERVER.md`, `docs/A2A-SERVER.md`, `docs/AGENT_PROTOCOLS_GUIDE.md`, `docs/CLOUD_AGENT.md` -- **Routing & resilience**: `docs/AUTO-COMBO.md`, `docs/RESILIENCE_GUIDE.md` -- **Security**: `docs/AUTHZ_GUIDE.md`, `docs/GUARDRAILS.md`, `docs/COMPLIANCE.md`, `docs/STEALTH_GUIDE.md` -- **Extensibility**: `docs/SKILLS.md`, `docs/MEMORY.md`, `docs/EVALS.md`, `docs/WEBHOOKS.md`, `docs/REASONING_REPLAY.md` -- **Platform**: `docs/ELECTRON_GUIDE.md`, `docs/TUNNELS_GUIDE.md` +- **Architecture & Reference**: `docs/architecture/ARCHITECTURE.md`, `docs/architecture/CODEBASE_DOCUMENTATION.md`, `docs/architecture/REPOSITORY_MAP.md`, `docs/reference/API_REFERENCE.md`, `docs/reference/PROVIDER_REFERENCE.md`, `docs/reference/openapi.yaml` +- **Operator guides**: `docs/guides/USER_GUIDE.md`, `docs/reference/CLI-TOOLS.md`, `docs/guides/TROUBLESHOOTING.md`, `docs/ops/COVERAGE_PLAN.md` +- **Protocols**: `docs/frameworks/MCP-SERVER.md`, `docs/frameworks/A2A-SERVER.md`, `docs/frameworks/AGENT_PROTOCOLS_GUIDE.md`, `docs/frameworks/CLOUD_AGENT.md` +- **Routing & resilience**: `docs/routing/AUTO-COMBO.md`, `docs/architecture/RESILIENCE_GUIDE.md` +- **Security**: `docs/architecture/AUTHZ_GUIDE.md`, `docs/security/GUARDRAILS.md`, `docs/security/COMPLIANCE.md`, `docs/security/STEALTH_GUIDE.md` +- **Extensibility**: `docs/frameworks/SKILLS.md`, `docs/frameworks/MEMORY.md`, `docs/frameworks/EVALS.md`, `docs/frameworks/WEBHOOKS.md`, `docs/routing/REASONING_REPLAY.md` +- **Platform**: `docs/guides/ELECTRON_GUIDE.md`, `docs/ops/TUNNELS_GUIDE.md` - **AI agents**: `CLAUDE.md`, `AGENTS.md`, `GEMINI.md` diff --git a/docs/i18n/pt/CHANGELOG.md b/docs/i18n/pt/CHANGELOG.md index 75de8ee268..04d780a2d0 100644 --- a/docs/i18n/pt/CHANGELOG.md +++ b/docs/i18n/pt/CHANGELOG.md @@ -1310,7 +1310,7 @@ We identified that **155 community PRs** across the entire project history (from - **33 New API Key Providers:** Massive provider expansion adding DeepInfra, Vercel AI Gateway, Lambda AI, SambaNova, nScale, OVHcloud AI, Baseten, PublicAI, Moonshot AI, Meta Llama API, v0 (Vercel), Morph, Featherless AI, FriendliAI, LlamaGate, Galadriel, Weights & Biases Inference, Volcengine, AI21 Labs, Venice.ai, Codestral, Upstage, Maritalk, Xiaomi MiMo, Inference.net, NanoGPT, Predibase, Bytez, Heroku AI, Databricks, Snowflake Cortex, and GigaChat (Sber). OmniRoute now supports **100+ providers** (4 Free + 8 OAuth + 91 API Key + Custom compatible) - **Global Email Privacy Toggle:** Added a persistent eye-icon toggle button across all dashboard pages (Providers, Usage Limits, Playground) that reveals or hides masked email addresses. Toggle state is stored in localStorage and synced globally via Zustand store - **Documentation Refresh:** Updated README, ARCHITECTURE, FEATURES, AGENTS.md, and API_REFERENCE for v3.6.2 with accurate provider counts (100+), new executor list, and system API documentation -- **Uninstall Guide:** Created comprehensive `docs/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) +- **Uninstall Guide:** Created comprehensive `docs/guides/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) ### 🐛 Bug Fixes diff --git a/docs/i18n/pt/CONTRIBUTING.md b/docs/i18n/pt/CONTRIBUTING.md index f1cc28f27a..9ee21156f9 100644 --- a/docs/i18n/pt/CONTRIBUTING.md +++ b/docs/i18n/pt/CONTRIBUTING.md @@ -153,7 +153,7 @@ Coverage notes: - If a PR changes production code in `src/`, `open-sse/`, `electron/`, or `bin/`, it must add or update automated tests in the same PR - `npm run coverage:report` prints the detailed file-by-file report from the latest coverage run - `npm run test:coverage:legacy` preserves the older metric for historical comparison -- See `docs/COVERAGE_PLAN.md` for the phased coverage improvement roadmap +- See `docs/ops/COVERAGE_PLAN.md` for the phased coverage improvement roadmap ### Pull Request Requirements @@ -305,7 +305,7 @@ Releases are managed via the `/generate-release` workflow. When a new GitHub Rel ## Getting Help -- **Architecture**: See [`docs/ARCHITECTURE.md`](docs/ARCHITECTURE.md) -- **API Reference**: See [`docs/API_REFERENCE.md`](docs/API_REFERENCE.md) +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](docs/architecture/ARCHITECTURE.md) +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](docs/reference/API_REFERENCE.md) - **Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) - **ADRs**: See `docs/adr/` for architectural decision records diff --git a/docs/i18n/pt/README.md b/docs/i18n/pt/README.md index 492246346b..ac2ed33e74 100644 --- a/docs/i18n/pt/README.md +++ b/docs/i18n/pt/README.md @@ -2267,25 +2267,25 @@ Se não quiser criar credenciais próprias agora, ainda é possível usar o flux ## Documentação -| Document | Description | -| -------------------------------------------------------- | --------------------------------------------------- | -| [User Guide](docs/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | -| [API Reference](docs/API_REFERENCE.md) | All endpoints with examples | -| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | -| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | -| [Auto-Combo Engine](docs/AUTO-COMBO.md) | 6-factor scoring, mode packs, self-healing | -| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | -| [Troubleshooting](docs/TROUBLESHOOTING.md) | Common problems and solutions | -| [Architecture](docs/ARCHITECTURE.md) | System architecture and internals | -| [Codebase Documentation](docs/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | -| [Uninstall Guide](docs/UNINSTALL.md) | Clean removal for all install methods | -| [Environment Config](docs/ENVIRONMENT.md) | Complete `.env` variables and references | -| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | -| [OpenAPI Spec](docs/openapi.yaml) | OpenAPI 3.0 specification | -| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | -| [VM Deployment](docs/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | -| [Features Gallery](docs/FEATURES.md) | Visual dashboard tour with screenshots | -| [Release Checklist](docs/RELEASE_CHECKLIST.md) | Pre-release validation steps | +| Document | Description | +| --------------------------------------------------------------------- | --------------------------------------------------- | +| [User Guide](docs/guides/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | +| [API Reference](docs/reference/API_REFERENCE.md) | All endpoints with examples | +| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | +| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | +| [Auto-Combo Engine](docs/routing/AUTO-COMBO.md) | 6-factor scoring, mode packs, self-healing | +| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | +| [Troubleshooting](docs/guides/TROUBLESHOOTING.md) | Common problems and solutions | +| [Architecture](docs/architecture/ARCHITECTURE.md) | System architecture and internals | +| [Codebase Documentation](docs/architecture/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | +| [Uninstall Guide](docs/guides/UNINSTALL.md) | Clean removal for all install methods | +| [Environment Config](docs/reference/ENVIRONMENT.md) | Complete `.env` variables and references | +| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | +| [OpenAPI Spec](docs/reference/openapi.yaml) | OpenAPI 3.0 specification | +| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | +| [VM Deployment](docs/ops/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | +| [Features Gallery](docs/guides/FEATURES.md) | Visual dashboard tour with screenshots | +| [Release Checklist](docs/ops/RELEASE_CHECKLIST.md) | Pre-release validation steps | --- diff --git a/docs/i18n/pt/docs/ARCHITECTURE.md b/docs/i18n/pt/docs/architecture/ARCHITECTURE.md similarity index 100% rename from docs/i18n/pt/docs/ARCHITECTURE.md rename to docs/i18n/pt/docs/architecture/ARCHITECTURE.md diff --git a/docs/i18n/pt/docs/CODEBASE_DOCUMENTATION.md b/docs/i18n/pt/docs/architecture/CODEBASE_DOCUMENTATION.md similarity index 100% rename from docs/i18n/pt/docs/CODEBASE_DOCUMENTATION.md rename to docs/i18n/pt/docs/architecture/CODEBASE_DOCUMENTATION.md diff --git a/docs/i18n/pt/docs/A2A-SERVER.md b/docs/i18n/pt/docs/frameworks/A2A-SERVER.md similarity index 100% rename from docs/i18n/pt/docs/A2A-SERVER.md rename to docs/i18n/pt/docs/frameworks/A2A-SERVER.md diff --git a/docs/i18n/pt/docs/MCP-SERVER.md b/docs/i18n/pt/docs/frameworks/MCP-SERVER.md similarity index 100% rename from docs/i18n/pt/docs/MCP-SERVER.md rename to docs/i18n/pt/docs/frameworks/MCP-SERVER.md diff --git a/docs/i18n/pt/docs/FEATURES.md b/docs/i18n/pt/docs/guides/FEATURES.md similarity index 100% rename from docs/i18n/pt/docs/FEATURES.md rename to docs/i18n/pt/docs/guides/FEATURES.md diff --git a/docs/i18n/pt/docs/I18N.md b/docs/i18n/pt/docs/guides/I18N.md similarity index 99% rename from docs/i18n/pt/docs/I18N.md rename to docs/i18n/pt/docs/guides/I18N.md index 868e52eca5..d3561b3f39 100644 --- a/docs/i18n/pt/docs/I18N.md +++ b/docs/i18n/pt/docs/guides/I18N.md @@ -420,7 +420,7 @@ The generator originally used `code: "in"` (deprecated Google Translate code) fo ### `docs/i18n/README.md` Is Auto-Generated -The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/I18N.md` (this file) for hand-written documentation that should persist. +The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/guides/I18N.md` (this file) for hand-written documentation that should persist. ### External Untranslatable Keys List diff --git a/docs/i18n/pt/docs/TROUBLESHOOTING.md b/docs/i18n/pt/docs/guides/TROUBLESHOOTING.md similarity index 98% rename from docs/i18n/pt/docs/TROUBLESHOOTING.md rename to docs/i18n/pt/docs/guides/TROUBLESHOOTING.md index 859151adc6..00914abc61 100644 --- a/docs/i18n/pt/docs/TROUBLESHOOTING.md +++ b/docs/i18n/pt/docs/guides/TROUBLESHOOTING.md @@ -335,7 +335,7 @@ You can ignore this section if you do not run RAG or agent pipelines behind Omni ## Still Stuck? - **GitHub Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) -- **Architecture**: See [`docs/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details -- **API Reference**: See [`docs/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints - **Health Dashboard**: Check **Dashboard → Health** for real-time system status - **Translator**: Use **Dashboard → Translator** to debug format issues diff --git a/docs/i18n/pt/docs/UNINSTALL.md b/docs/i18n/pt/docs/guides/UNINSTALL.md similarity index 100% rename from docs/i18n/pt/docs/UNINSTALL.md rename to docs/i18n/pt/docs/guides/UNINSTALL.md diff --git a/docs/i18n/pt/docs/USER_GUIDE.md b/docs/i18n/pt/docs/guides/USER_GUIDE.md similarity index 100% rename from docs/i18n/pt/docs/USER_GUIDE.md rename to docs/i18n/pt/docs/guides/USER_GUIDE.md diff --git a/docs/i18n/pt/docs/COVERAGE_PLAN.md b/docs/i18n/pt/docs/ops/COVERAGE_PLAN.md similarity index 100% rename from docs/i18n/pt/docs/COVERAGE_PLAN.md rename to docs/i18n/pt/docs/ops/COVERAGE_PLAN.md diff --git a/docs/i18n/pt/docs/FLY_IO_DEPLOYMENT_GUIDE.md b/docs/i18n/pt/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/pt/docs/FLY_IO_DEPLOYMENT_GUIDE.md rename to docs/i18n/pt/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/pt/docs/RELEASE_CHECKLIST.md b/docs/i18n/pt/docs/ops/RELEASE_CHECKLIST.md similarity index 94% rename from docs/i18n/pt/docs/RELEASE_CHECKLIST.md rename to docs/i18n/pt/docs/ops/RELEASE_CHECKLIST.md index 7da2fdeee8..025b360d9c 100644 --- a/docs/i18n/pt/docs/RELEASE_CHECKLIST.md +++ b/docs/i18n/pt/docs/ops/RELEASE_CHECKLIST.md @@ -16,14 +16,14 @@ Use this checklist before tagging or publishing a new OmniRoute release. ## API Docs -1. Update `docs/openapi.yaml`: +1. Update `docs/reference/openapi.yaml`: - `info.version` must equal `package.json` version. 2. Validate endpoint examples if API contracts changed. ## Runtime Docs -1. Review `docs/ARCHITECTURE.md` for storage/runtime drift. -2. Review `docs/TROUBLESHOOTING.md` for env var and operational drift. +1. Review `docs/architecture/ARCHITECTURE.md` for storage/runtime drift. +2. Review `docs/guides/TROUBLESHOOTING.md` for env var and operational drift. 3. Verify the release/runtime Node.js version still satisfies the supported secure floor: - `>=20.20.2 <21` or `>=22.22.2 <23` - `npm run check:node-runtime` diff --git a/docs/i18n/pt/docs/VM_DEPLOYMENT_GUIDE.md b/docs/i18n/pt/docs/ops/VM_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/pt/docs/VM_DEPLOYMENT_GUIDE.md rename to docs/i18n/pt/docs/ops/VM_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/pt/docs/API_REFERENCE.md b/docs/i18n/pt/docs/reference/API_REFERENCE.md similarity index 100% rename from docs/i18n/pt/docs/API_REFERENCE.md rename to docs/i18n/pt/docs/reference/API_REFERENCE.md diff --git a/docs/i18n/pt/docs/CLI-TOOLS.md b/docs/i18n/pt/docs/reference/CLI-TOOLS.md similarity index 100% rename from docs/i18n/pt/docs/CLI-TOOLS.md rename to docs/i18n/pt/docs/reference/CLI-TOOLS.md diff --git a/docs/i18n/pt/docs/ENVIRONMENT.md b/docs/i18n/pt/docs/reference/ENVIRONMENT.md similarity index 100% rename from docs/i18n/pt/docs/ENVIRONMENT.md rename to docs/i18n/pt/docs/reference/ENVIRONMENT.md diff --git a/docs/i18n/pt/docs/AUTO-COMBO.md b/docs/i18n/pt/docs/routing/AUTO-COMBO.md similarity index 100% rename from docs/i18n/pt/docs/AUTO-COMBO.md rename to docs/i18n/pt/docs/routing/AUTO-COMBO.md diff --git a/docs/i18n/pt/llm.txt b/docs/i18n/pt/llm.txt index 5a996733a1..b580eb63e5 100644 --- a/docs/i18n/pt/llm.txt +++ b/docs/i18n/pt/llm.txt @@ -357,11 +357,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### MCP Server (37 Tools) | Category | Tools | |------------|-------| -| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/MCP-SERVER.md` for full inventory) | +| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/frameworks/MCP-SERVER.md` for full inventory) | | Memory (3) | `memory_search`, `memory_add`, `memory_clear` | | Skills (4) | `skills_list`, `skills_enable`, `skills_execute`, `skills_executions` | -**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/MCP-SERVER.md`. +**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/frameworks/MCP-SERVER.md`. ### Provider Categories @@ -472,7 +472,7 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo 20. **Guardrails framework** in `src/lib/guardrails/` — hot-reloadable registry. Built-ins (priority-ordered): `vision-bridge` (5) → `pii-masker` (10) → `prompt-injection` (20). Fail-open model: exceptions never block traffic. Per-request opt-out via `x-omniroute-disabled-guardrails` header. -21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/AUTHZ_GUIDE.md`. +21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/architecture/AUTHZ_GUIDE.md`. 22. **Three resilience layers** are distinct (do not conflate them): - **Provider Circuit Breaker** (`src/shared/utils/circuitBreaker.ts`) — whole-provider scope. @@ -489,11 +489,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo - **MCP server expanded to 37 tools** (30 base + 3 memory + 4 skills) across ~13 scopes - **OAuth providers expanded to 14**: added Qwen, Kiro, Qoder, Gemini, Windsurf, GitLab Duo - **Coverage gate raised to 75/75/75/70** (was 60% across the board) — measured ~82% -- **Reasoning replay** (`docs/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams +- **Reasoning replay** (`docs/routing/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams - **Compliance + Evals + Webhooks** documentation introduced -- **Stealth guide** (`docs/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration -- **Tunnels guide** (`docs/TUNNELS_GUIDE.md`) — Cloudflare tunnel management -- **Electron guide** (`docs/ELECTRON_GUIDE.md`) — desktop app build + signing +- **Stealth guide** (`docs/security/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration +- **Tunnels guide** (`docs/ops/TUNNELS_GUIDE.md`) — Cloudflare tunnel management +- **Electron guide** (`docs/guides/ELECTRON_GUIDE.md`) — desktop app build + signing ## Links @@ -505,11 +505,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### Documentation Index -- **Architecture & Reference**: `docs/ARCHITECTURE.md`, `docs/CODEBASE_DOCUMENTATION.md`, `docs/REPOSITORY_MAP.md`, `docs/API_REFERENCE.md`, `docs/PROVIDER_REFERENCE.md`, `docs/openapi.yaml` -- **Operator guides**: `docs/USER_GUIDE.md`, `docs/CLI-TOOLS.md`, `docs/TROUBLESHOOTING.md`, `docs/COVERAGE_PLAN.md` -- **Protocols**: `docs/MCP-SERVER.md`, `docs/A2A-SERVER.md`, `docs/AGENT_PROTOCOLS_GUIDE.md`, `docs/CLOUD_AGENT.md` -- **Routing & resilience**: `docs/AUTO-COMBO.md`, `docs/RESILIENCE_GUIDE.md` -- **Security**: `docs/AUTHZ_GUIDE.md`, `docs/GUARDRAILS.md`, `docs/COMPLIANCE.md`, `docs/STEALTH_GUIDE.md` -- **Extensibility**: `docs/SKILLS.md`, `docs/MEMORY.md`, `docs/EVALS.md`, `docs/WEBHOOKS.md`, `docs/REASONING_REPLAY.md` -- **Platform**: `docs/ELECTRON_GUIDE.md`, `docs/TUNNELS_GUIDE.md` +- **Architecture & Reference**: `docs/architecture/ARCHITECTURE.md`, `docs/architecture/CODEBASE_DOCUMENTATION.md`, `docs/architecture/REPOSITORY_MAP.md`, `docs/reference/API_REFERENCE.md`, `docs/reference/PROVIDER_REFERENCE.md`, `docs/reference/openapi.yaml` +- **Operator guides**: `docs/guides/USER_GUIDE.md`, `docs/reference/CLI-TOOLS.md`, `docs/guides/TROUBLESHOOTING.md`, `docs/ops/COVERAGE_PLAN.md` +- **Protocols**: `docs/frameworks/MCP-SERVER.md`, `docs/frameworks/A2A-SERVER.md`, `docs/frameworks/AGENT_PROTOCOLS_GUIDE.md`, `docs/frameworks/CLOUD_AGENT.md` +- **Routing & resilience**: `docs/routing/AUTO-COMBO.md`, `docs/architecture/RESILIENCE_GUIDE.md` +- **Security**: `docs/architecture/AUTHZ_GUIDE.md`, `docs/security/GUARDRAILS.md`, `docs/security/COMPLIANCE.md`, `docs/security/STEALTH_GUIDE.md` +- **Extensibility**: `docs/frameworks/SKILLS.md`, `docs/frameworks/MEMORY.md`, `docs/frameworks/EVALS.md`, `docs/frameworks/WEBHOOKS.md`, `docs/routing/REASONING_REPLAY.md` +- **Platform**: `docs/guides/ELECTRON_GUIDE.md`, `docs/ops/TUNNELS_GUIDE.md` - **AI agents**: `CLAUDE.md`, `AGENTS.md`, `GEMINI.md` diff --git a/docs/i18n/ro/CHANGELOG.md b/docs/i18n/ro/CHANGELOG.md index 280978130b..1b9740a6df 100644 --- a/docs/i18n/ro/CHANGELOG.md +++ b/docs/i18n/ro/CHANGELOG.md @@ -1310,7 +1310,7 @@ We identified that **155 community PRs** across the entire project history (from - **33 New API Key Providers:** Massive provider expansion adding DeepInfra, Vercel AI Gateway, Lambda AI, SambaNova, nScale, OVHcloud AI, Baseten, PublicAI, Moonshot AI, Meta Llama API, v0 (Vercel), Morph, Featherless AI, FriendliAI, LlamaGate, Galadriel, Weights & Biases Inference, Volcengine, AI21 Labs, Venice.ai, Codestral, Upstage, Maritalk, Xiaomi MiMo, Inference.net, NanoGPT, Predibase, Bytez, Heroku AI, Databricks, Snowflake Cortex, and GigaChat (Sber). OmniRoute now supports **100+ providers** (4 Free + 8 OAuth + 91 API Key + Custom compatible) - **Global Email Privacy Toggle:** Added a persistent eye-icon toggle button across all dashboard pages (Providers, Usage Limits, Playground) that reveals or hides masked email addresses. Toggle state is stored in localStorage and synced globally via Zustand store - **Documentation Refresh:** Updated README, ARCHITECTURE, FEATURES, AGENTS.md, and API_REFERENCE for v3.6.2 with accurate provider counts (100+), new executor list, and system API documentation -- **Uninstall Guide:** Created comprehensive `docs/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) +- **Uninstall Guide:** Created comprehensive `docs/guides/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) ### 🐛 Bug Fixes diff --git a/docs/i18n/ro/CONTRIBUTING.md b/docs/i18n/ro/CONTRIBUTING.md index 8b8057ed7c..3b590380db 100644 --- a/docs/i18n/ro/CONTRIBUTING.md +++ b/docs/i18n/ro/CONTRIBUTING.md @@ -153,7 +153,7 @@ Coverage notes: - If a PR changes production code in `src/`, `open-sse/`, `electron/`, or `bin/`, it must add or update automated tests in the same PR - `npm run coverage:report` prints the detailed file-by-file report from the latest coverage run - `npm run test:coverage:legacy` preserves the older metric for historical comparison -- See `docs/COVERAGE_PLAN.md` for the phased coverage improvement roadmap +- See `docs/ops/COVERAGE_PLAN.md` for the phased coverage improvement roadmap ### Pull Request Requirements @@ -305,7 +305,7 @@ Releases are managed via the `/generate-release` workflow. When a new GitHub Rel ## Getting Help -- **Architecture**: See [`docs/ARCHITECTURE.md`](docs/ARCHITECTURE.md) -- **API Reference**: See [`docs/API_REFERENCE.md`](docs/API_REFERENCE.md) +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](docs/architecture/ARCHITECTURE.md) +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](docs/reference/API_REFERENCE.md) - **Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) - **ADRs**: See `docs/adr/` for architectural decision records diff --git a/docs/i18n/ro/README.md b/docs/i18n/ro/README.md index 2c71b54ebd..d093296081 100644 --- a/docs/i18n/ro/README.md +++ b/docs/i18n/ro/README.md @@ -2267,25 +2267,25 @@ Se não quiser criar credenciais próprias agora, ainda é possível usar o flux ## Documentație -| Document | Description | -| -------------------------------------------------------- | --------------------------------------------------- | -| [User Guide](docs/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | -| [API Reference](docs/API_REFERENCE.md) | All endpoints with examples | -| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | -| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | -| [Auto-Combo Engine](docs/AUTO-COMBO.md) | 6-factor scoring, mode packs, self-healing | -| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | -| [Troubleshooting](docs/TROUBLESHOOTING.md) | Common problems and solutions | -| [Architecture](docs/ARCHITECTURE.md) | System architecture and internals | -| [Codebase Documentation](docs/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | -| [Uninstall Guide](docs/UNINSTALL.md) | Clean removal for all install methods | -| [Environment Config](docs/ENVIRONMENT.md) | Complete `.env` variables and references | -| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | -| [OpenAPI Spec](docs/openapi.yaml) | OpenAPI 3.0 specification | -| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | -| [VM Deployment](docs/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | -| [Features Gallery](docs/FEATURES.md) | Visual dashboard tour with screenshots | -| [Release Checklist](docs/RELEASE_CHECKLIST.md) | Pre-release validation steps | +| Document | Description | +| --------------------------------------------------------------------- | --------------------------------------------------- | +| [User Guide](docs/guides/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | +| [API Reference](docs/reference/API_REFERENCE.md) | All endpoints with examples | +| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | +| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | +| [Auto-Combo Engine](docs/routing/AUTO-COMBO.md) | 6-factor scoring, mode packs, self-healing | +| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | +| [Troubleshooting](docs/guides/TROUBLESHOOTING.md) | Common problems and solutions | +| [Architecture](docs/architecture/ARCHITECTURE.md) | System architecture and internals | +| [Codebase Documentation](docs/architecture/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | +| [Uninstall Guide](docs/guides/UNINSTALL.md) | Clean removal for all install methods | +| [Environment Config](docs/reference/ENVIRONMENT.md) | Complete `.env` variables and references | +| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | +| [OpenAPI Spec](docs/reference/openapi.yaml) | OpenAPI 3.0 specification | +| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | +| [VM Deployment](docs/ops/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | +| [Features Gallery](docs/guides/FEATURES.md) | Visual dashboard tour with screenshots | +| [Release Checklist](docs/ops/RELEASE_CHECKLIST.md) | Pre-release validation steps | --- diff --git a/docs/i18n/ro/docs/ARCHITECTURE.md b/docs/i18n/ro/docs/architecture/ARCHITECTURE.md similarity index 100% rename from docs/i18n/ro/docs/ARCHITECTURE.md rename to docs/i18n/ro/docs/architecture/ARCHITECTURE.md diff --git a/docs/i18n/ro/docs/CODEBASE_DOCUMENTATION.md b/docs/i18n/ro/docs/architecture/CODEBASE_DOCUMENTATION.md similarity index 100% rename from docs/i18n/ro/docs/CODEBASE_DOCUMENTATION.md rename to docs/i18n/ro/docs/architecture/CODEBASE_DOCUMENTATION.md diff --git a/docs/i18n/ro/docs/A2A-SERVER.md b/docs/i18n/ro/docs/frameworks/A2A-SERVER.md similarity index 100% rename from docs/i18n/ro/docs/A2A-SERVER.md rename to docs/i18n/ro/docs/frameworks/A2A-SERVER.md diff --git a/docs/i18n/ro/docs/MCP-SERVER.md b/docs/i18n/ro/docs/frameworks/MCP-SERVER.md similarity index 100% rename from docs/i18n/ro/docs/MCP-SERVER.md rename to docs/i18n/ro/docs/frameworks/MCP-SERVER.md diff --git a/docs/i18n/ro/docs/FEATURES.md b/docs/i18n/ro/docs/guides/FEATURES.md similarity index 100% rename from docs/i18n/ro/docs/FEATURES.md rename to docs/i18n/ro/docs/guides/FEATURES.md diff --git a/docs/i18n/ro/docs/I18N.md b/docs/i18n/ro/docs/guides/I18N.md similarity index 99% rename from docs/i18n/ro/docs/I18N.md rename to docs/i18n/ro/docs/guides/I18N.md index 75177748a1..e7f6e94720 100644 --- a/docs/i18n/ro/docs/I18N.md +++ b/docs/i18n/ro/docs/guides/I18N.md @@ -420,7 +420,7 @@ The generator originally used `code: "in"` (deprecated Google Translate code) fo ### `docs/i18n/README.md` Is Auto-Generated -The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/I18N.md` (this file) for hand-written documentation that should persist. +The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/guides/I18N.md` (this file) for hand-written documentation that should persist. ### External Untranslatable Keys List diff --git a/docs/i18n/ro/docs/TROUBLESHOOTING.md b/docs/i18n/ro/docs/guides/TROUBLESHOOTING.md similarity index 98% rename from docs/i18n/ro/docs/TROUBLESHOOTING.md rename to docs/i18n/ro/docs/guides/TROUBLESHOOTING.md index 81043c9a37..298dc196f9 100644 --- a/docs/i18n/ro/docs/TROUBLESHOOTING.md +++ b/docs/i18n/ro/docs/guides/TROUBLESHOOTING.md @@ -335,7 +335,7 @@ You can ignore this section if you do not run RAG or agent pipelines behind Omni ## Still Stuck? - **GitHub Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) -- **Architecture**: See [`docs/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details -- **API Reference**: See [`docs/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints - **Health Dashboard**: Check **Dashboard → Health** for real-time system status - **Translator**: Use **Dashboard → Translator** to debug format issues diff --git a/docs/i18n/ro/docs/UNINSTALL.md b/docs/i18n/ro/docs/guides/UNINSTALL.md similarity index 100% rename from docs/i18n/ro/docs/UNINSTALL.md rename to docs/i18n/ro/docs/guides/UNINSTALL.md diff --git a/docs/i18n/ro/docs/USER_GUIDE.md b/docs/i18n/ro/docs/guides/USER_GUIDE.md similarity index 100% rename from docs/i18n/ro/docs/USER_GUIDE.md rename to docs/i18n/ro/docs/guides/USER_GUIDE.md diff --git a/docs/i18n/ro/docs/COVERAGE_PLAN.md b/docs/i18n/ro/docs/ops/COVERAGE_PLAN.md similarity index 100% rename from docs/i18n/ro/docs/COVERAGE_PLAN.md rename to docs/i18n/ro/docs/ops/COVERAGE_PLAN.md diff --git a/docs/i18n/ro/docs/FLY_IO_DEPLOYMENT_GUIDE.md b/docs/i18n/ro/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/ro/docs/FLY_IO_DEPLOYMENT_GUIDE.md rename to docs/i18n/ro/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/ro/docs/RELEASE_CHECKLIST.md b/docs/i18n/ro/docs/ops/RELEASE_CHECKLIST.md similarity index 94% rename from docs/i18n/ro/docs/RELEASE_CHECKLIST.md rename to docs/i18n/ro/docs/ops/RELEASE_CHECKLIST.md index b2bc96dcde..905d05a5da 100644 --- a/docs/i18n/ro/docs/RELEASE_CHECKLIST.md +++ b/docs/i18n/ro/docs/ops/RELEASE_CHECKLIST.md @@ -16,14 +16,14 @@ Use this checklist before tagging or publishing a new OmniRoute release. ## API Docs -1. Update `docs/openapi.yaml`: +1. Update `docs/reference/openapi.yaml`: - `info.version` must equal `package.json` version. 2. Validate endpoint examples if API contracts changed. ## Runtime Docs -1. Review `docs/ARCHITECTURE.md` for storage/runtime drift. -2. Review `docs/TROUBLESHOOTING.md` for env var and operational drift. +1. Review `docs/architecture/ARCHITECTURE.md` for storage/runtime drift. +2. Review `docs/guides/TROUBLESHOOTING.md` for env var and operational drift. 3. Verify the release/runtime Node.js version still satisfies the supported secure floor: - `>=20.20.2 <21` or `>=22.22.2 <23` - `npm run check:node-runtime` diff --git a/docs/i18n/ro/docs/VM_DEPLOYMENT_GUIDE.md b/docs/i18n/ro/docs/ops/VM_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/ro/docs/VM_DEPLOYMENT_GUIDE.md rename to docs/i18n/ro/docs/ops/VM_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/ro/docs/API_REFERENCE.md b/docs/i18n/ro/docs/reference/API_REFERENCE.md similarity index 100% rename from docs/i18n/ro/docs/API_REFERENCE.md rename to docs/i18n/ro/docs/reference/API_REFERENCE.md diff --git a/docs/i18n/ro/docs/CLI-TOOLS.md b/docs/i18n/ro/docs/reference/CLI-TOOLS.md similarity index 100% rename from docs/i18n/ro/docs/CLI-TOOLS.md rename to docs/i18n/ro/docs/reference/CLI-TOOLS.md diff --git a/docs/i18n/ro/docs/ENVIRONMENT.md b/docs/i18n/ro/docs/reference/ENVIRONMENT.md similarity index 100% rename from docs/i18n/ro/docs/ENVIRONMENT.md rename to docs/i18n/ro/docs/reference/ENVIRONMENT.md diff --git a/docs/i18n/ro/docs/AUTO-COMBO.md b/docs/i18n/ro/docs/routing/AUTO-COMBO.md similarity index 100% rename from docs/i18n/ro/docs/AUTO-COMBO.md rename to docs/i18n/ro/docs/routing/AUTO-COMBO.md diff --git a/docs/i18n/ro/llm.txt b/docs/i18n/ro/llm.txt index 820e67516a..4b5e16c1ab 100644 --- a/docs/i18n/ro/llm.txt +++ b/docs/i18n/ro/llm.txt @@ -357,11 +357,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### MCP Server (37 Tools) | Category | Tools | |------------|-------| -| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/MCP-SERVER.md` for full inventory) | +| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/frameworks/MCP-SERVER.md` for full inventory) | | Memory (3) | `memory_search`, `memory_add`, `memory_clear` | | Skills (4) | `skills_list`, `skills_enable`, `skills_execute`, `skills_executions` | -**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/MCP-SERVER.md`. +**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/frameworks/MCP-SERVER.md`. ### Provider Categories @@ -472,7 +472,7 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo 20. **Guardrails framework** in `src/lib/guardrails/` — hot-reloadable registry. Built-ins (priority-ordered): `vision-bridge` (5) → `pii-masker` (10) → `prompt-injection` (20). Fail-open model: exceptions never block traffic. Per-request opt-out via `x-omniroute-disabled-guardrails` header. -21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/AUTHZ_GUIDE.md`. +21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/architecture/AUTHZ_GUIDE.md`. 22. **Three resilience layers** are distinct (do not conflate them): - **Provider Circuit Breaker** (`src/shared/utils/circuitBreaker.ts`) — whole-provider scope. @@ -489,11 +489,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo - **MCP server expanded to 37 tools** (30 base + 3 memory + 4 skills) across ~13 scopes - **OAuth providers expanded to 14**: added Qwen, Kiro, Qoder, Gemini, Windsurf, GitLab Duo - **Coverage gate raised to 75/75/75/70** (was 60% across the board) — measured ~82% -- **Reasoning replay** (`docs/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams +- **Reasoning replay** (`docs/routing/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams - **Compliance + Evals + Webhooks** documentation introduced -- **Stealth guide** (`docs/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration -- **Tunnels guide** (`docs/TUNNELS_GUIDE.md`) — Cloudflare tunnel management -- **Electron guide** (`docs/ELECTRON_GUIDE.md`) — desktop app build + signing +- **Stealth guide** (`docs/security/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration +- **Tunnels guide** (`docs/ops/TUNNELS_GUIDE.md`) — Cloudflare tunnel management +- **Electron guide** (`docs/guides/ELECTRON_GUIDE.md`) — desktop app build + signing ## Links @@ -505,11 +505,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### Documentation Index -- **Architecture & Reference**: `docs/ARCHITECTURE.md`, `docs/CODEBASE_DOCUMENTATION.md`, `docs/REPOSITORY_MAP.md`, `docs/API_REFERENCE.md`, `docs/PROVIDER_REFERENCE.md`, `docs/openapi.yaml` -- **Operator guides**: `docs/USER_GUIDE.md`, `docs/CLI-TOOLS.md`, `docs/TROUBLESHOOTING.md`, `docs/COVERAGE_PLAN.md` -- **Protocols**: `docs/MCP-SERVER.md`, `docs/A2A-SERVER.md`, `docs/AGENT_PROTOCOLS_GUIDE.md`, `docs/CLOUD_AGENT.md` -- **Routing & resilience**: `docs/AUTO-COMBO.md`, `docs/RESILIENCE_GUIDE.md` -- **Security**: `docs/AUTHZ_GUIDE.md`, `docs/GUARDRAILS.md`, `docs/COMPLIANCE.md`, `docs/STEALTH_GUIDE.md` -- **Extensibility**: `docs/SKILLS.md`, `docs/MEMORY.md`, `docs/EVALS.md`, `docs/WEBHOOKS.md`, `docs/REASONING_REPLAY.md` -- **Platform**: `docs/ELECTRON_GUIDE.md`, `docs/TUNNELS_GUIDE.md` +- **Architecture & Reference**: `docs/architecture/ARCHITECTURE.md`, `docs/architecture/CODEBASE_DOCUMENTATION.md`, `docs/architecture/REPOSITORY_MAP.md`, `docs/reference/API_REFERENCE.md`, `docs/reference/PROVIDER_REFERENCE.md`, `docs/reference/openapi.yaml` +- **Operator guides**: `docs/guides/USER_GUIDE.md`, `docs/reference/CLI-TOOLS.md`, `docs/guides/TROUBLESHOOTING.md`, `docs/ops/COVERAGE_PLAN.md` +- **Protocols**: `docs/frameworks/MCP-SERVER.md`, `docs/frameworks/A2A-SERVER.md`, `docs/frameworks/AGENT_PROTOCOLS_GUIDE.md`, `docs/frameworks/CLOUD_AGENT.md` +- **Routing & resilience**: `docs/routing/AUTO-COMBO.md`, `docs/architecture/RESILIENCE_GUIDE.md` +- **Security**: `docs/architecture/AUTHZ_GUIDE.md`, `docs/security/GUARDRAILS.md`, `docs/security/COMPLIANCE.md`, `docs/security/STEALTH_GUIDE.md` +- **Extensibility**: `docs/frameworks/SKILLS.md`, `docs/frameworks/MEMORY.md`, `docs/frameworks/EVALS.md`, `docs/frameworks/WEBHOOKS.md`, `docs/routing/REASONING_REPLAY.md` +- **Platform**: `docs/guides/ELECTRON_GUIDE.md`, `docs/ops/TUNNELS_GUIDE.md` - **AI agents**: `CLAUDE.md`, `AGENTS.md`, `GEMINI.md` diff --git a/docs/i18n/ru/CHANGELOG.md b/docs/i18n/ru/CHANGELOG.md index 6accb1e881..6219c06149 100644 --- a/docs/i18n/ru/CHANGELOG.md +++ b/docs/i18n/ru/CHANGELOG.md @@ -1310,7 +1310,7 @@ We identified that **155 community PRs** across the entire project history (from - **33 New API Key Providers:** Massive provider expansion adding DeepInfra, Vercel AI Gateway, Lambda AI, SambaNova, nScale, OVHcloud AI, Baseten, PublicAI, Moonshot AI, Meta Llama API, v0 (Vercel), Morph, Featherless AI, FriendliAI, LlamaGate, Galadriel, Weights & Biases Inference, Volcengine, AI21 Labs, Venice.ai, Codestral, Upstage, Maritalk, Xiaomi MiMo, Inference.net, NanoGPT, Predibase, Bytez, Heroku AI, Databricks, Snowflake Cortex, and GigaChat (Sber). OmniRoute now supports **100+ providers** (4 Free + 8 OAuth + 91 API Key + Custom compatible) - **Global Email Privacy Toggle:** Added a persistent eye-icon toggle button across all dashboard pages (Providers, Usage Limits, Playground) that reveals or hides masked email addresses. Toggle state is stored in localStorage and synced globally via Zustand store - **Documentation Refresh:** Updated README, ARCHITECTURE, FEATURES, AGENTS.md, and API_REFERENCE for v3.6.2 with accurate provider counts (100+), new executor list, and system API documentation -- **Uninstall Guide:** Created comprehensive `docs/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) +- **Uninstall Guide:** Created comprehensive `docs/guides/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) ### 🐛 Bug Fixes diff --git a/docs/i18n/ru/CONTRIBUTING.md b/docs/i18n/ru/CONTRIBUTING.md index d9c4fa94e1..4e57f76533 100644 --- a/docs/i18n/ru/CONTRIBUTING.md +++ b/docs/i18n/ru/CONTRIBUTING.md @@ -153,7 +153,7 @@ Coverage notes: - If a PR changes production code in `src/`, `open-sse/`, `electron/`, or `bin/`, it must add or update automated tests in the same PR - `npm run coverage:report` prints the detailed file-by-file report from the latest coverage run - `npm run test:coverage:legacy` preserves the older metric for historical comparison -- See `docs/COVERAGE_PLAN.md` for the phased coverage improvement roadmap +- See `docs/ops/COVERAGE_PLAN.md` for the phased coverage improvement roadmap ### Pull Request Requirements @@ -305,7 +305,7 @@ Releases are managed via the `/generate-release` workflow. When a new GitHub Rel ## Getting Help -- **Architecture**: See [`docs/ARCHITECTURE.md`](docs/ARCHITECTURE.md) -- **API Reference**: See [`docs/API_REFERENCE.md`](docs/API_REFERENCE.md) +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](docs/architecture/ARCHITECTURE.md) +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](docs/reference/API_REFERENCE.md) - **Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) - **ADRs**: See `docs/adr/` for architectural decision records diff --git a/docs/i18n/ru/README.md b/docs/i18n/ru/README.md index 4a2a384558..2273678d9b 100644 --- a/docs/i18n/ru/README.md +++ b/docs/i18n/ru/README.md @@ -2267,25 +2267,25 @@ Se não quiser criar credenciais próprias agora, ainda é possível usar o flux ## Документация -| Document | Description | -| -------------------------------------------------------- | --------------------------------------------------- | -| [User Guide](docs/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | -| [API Reference](docs/API_REFERENCE.md) | All endpoints with examples | -| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | -| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | -| [Auto-Combo Engine](docs/AUTO-COMBO.md) | 6-factor scoring, mode packs, self-healing | -| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | -| [Troubleshooting](docs/TROUBLESHOOTING.md) | Common problems and solutions | -| [Architecture](docs/ARCHITECTURE.md) | System architecture and internals | -| [Codebase Documentation](docs/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | -| [Uninstall Guide](docs/UNINSTALL.md) | Clean removal for all install methods | -| [Environment Config](docs/ENVIRONMENT.md) | Complete `.env` variables and references | -| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | -| [OpenAPI Spec](docs/openapi.yaml) | OpenAPI 3.0 specification | -| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | -| [VM Deployment](docs/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | -| [Features Gallery](docs/FEATURES.md) | Visual dashboard tour with screenshots | -| [Release Checklist](docs/RELEASE_CHECKLIST.md) | Pre-release validation steps | +| Document | Description | +| --------------------------------------------------------------------- | --------------------------------------------------- | +| [User Guide](docs/guides/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | +| [API Reference](docs/reference/API_REFERENCE.md) | All endpoints with examples | +| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | +| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | +| [Auto-Combo Engine](docs/routing/AUTO-COMBO.md) | 6-factor scoring, mode packs, self-healing | +| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | +| [Troubleshooting](docs/guides/TROUBLESHOOTING.md) | Common problems and solutions | +| [Architecture](docs/architecture/ARCHITECTURE.md) | System architecture and internals | +| [Codebase Documentation](docs/architecture/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | +| [Uninstall Guide](docs/guides/UNINSTALL.md) | Clean removal for all install methods | +| [Environment Config](docs/reference/ENVIRONMENT.md) | Complete `.env` variables and references | +| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | +| [OpenAPI Spec](docs/reference/openapi.yaml) | OpenAPI 3.0 specification | +| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | +| [VM Deployment](docs/ops/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | +| [Features Gallery](docs/guides/FEATURES.md) | Visual dashboard tour with screenshots | +| [Release Checklist](docs/ops/RELEASE_CHECKLIST.md) | Pre-release validation steps | --- diff --git a/docs/i18n/ru/docs/ARCHITECTURE.md b/docs/i18n/ru/docs/architecture/ARCHITECTURE.md similarity index 100% rename from docs/i18n/ru/docs/ARCHITECTURE.md rename to docs/i18n/ru/docs/architecture/ARCHITECTURE.md diff --git a/docs/i18n/ru/docs/CODEBASE_DOCUMENTATION.md b/docs/i18n/ru/docs/architecture/CODEBASE_DOCUMENTATION.md similarity index 100% rename from docs/i18n/ru/docs/CODEBASE_DOCUMENTATION.md rename to docs/i18n/ru/docs/architecture/CODEBASE_DOCUMENTATION.md diff --git a/docs/i18n/ru/docs/A2A-SERVER.md b/docs/i18n/ru/docs/frameworks/A2A-SERVER.md similarity index 100% rename from docs/i18n/ru/docs/A2A-SERVER.md rename to docs/i18n/ru/docs/frameworks/A2A-SERVER.md diff --git a/docs/i18n/ru/docs/MCP-SERVER.md b/docs/i18n/ru/docs/frameworks/MCP-SERVER.md similarity index 100% rename from docs/i18n/ru/docs/MCP-SERVER.md rename to docs/i18n/ru/docs/frameworks/MCP-SERVER.md diff --git a/docs/i18n/ru/docs/FEATURES.md b/docs/i18n/ru/docs/guides/FEATURES.md similarity index 100% rename from docs/i18n/ru/docs/FEATURES.md rename to docs/i18n/ru/docs/guides/FEATURES.md diff --git a/docs/i18n/ru/docs/I18N.md b/docs/i18n/ru/docs/guides/I18N.md similarity index 99% rename from docs/i18n/ru/docs/I18N.md rename to docs/i18n/ru/docs/guides/I18N.md index cfa5f8d303..87279292f0 100644 --- a/docs/i18n/ru/docs/I18N.md +++ b/docs/i18n/ru/docs/guides/I18N.md @@ -420,7 +420,7 @@ The generator originally used `code: "in"` (deprecated Google Translate code) fo ### `docs/i18n/README.md` Is Auto-Generated -The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/I18N.md` (this file) for hand-written documentation that should persist. +The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/guides/I18N.md` (this file) for hand-written documentation that should persist. ### External Untranslatable Keys List diff --git a/docs/i18n/ru/docs/TROUBLESHOOTING.md b/docs/i18n/ru/docs/guides/TROUBLESHOOTING.md similarity index 98% rename from docs/i18n/ru/docs/TROUBLESHOOTING.md rename to docs/i18n/ru/docs/guides/TROUBLESHOOTING.md index 9095358ebc..9fa7cd15ad 100644 --- a/docs/i18n/ru/docs/TROUBLESHOOTING.md +++ b/docs/i18n/ru/docs/guides/TROUBLESHOOTING.md @@ -335,7 +335,7 @@ You can ignore this section if you do not run RAG or agent pipelines behind Omni ## Still Stuck? - **GitHub Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) -- **Architecture**: See [`docs/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details -- **API Reference**: See [`docs/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints - **Health Dashboard**: Check **Dashboard → Health** for real-time system status - **Translator**: Use **Dashboard → Translator** to debug format issues diff --git a/docs/i18n/ru/docs/UNINSTALL.md b/docs/i18n/ru/docs/guides/UNINSTALL.md similarity index 100% rename from docs/i18n/ru/docs/UNINSTALL.md rename to docs/i18n/ru/docs/guides/UNINSTALL.md diff --git a/docs/i18n/ru/docs/USER_GUIDE.md b/docs/i18n/ru/docs/guides/USER_GUIDE.md similarity index 100% rename from docs/i18n/ru/docs/USER_GUIDE.md rename to docs/i18n/ru/docs/guides/USER_GUIDE.md diff --git a/docs/i18n/ru/docs/COVERAGE_PLAN.md b/docs/i18n/ru/docs/ops/COVERAGE_PLAN.md similarity index 100% rename from docs/i18n/ru/docs/COVERAGE_PLAN.md rename to docs/i18n/ru/docs/ops/COVERAGE_PLAN.md diff --git a/docs/i18n/ru/docs/FLY_IO_DEPLOYMENT_GUIDE.md b/docs/i18n/ru/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/ru/docs/FLY_IO_DEPLOYMENT_GUIDE.md rename to docs/i18n/ru/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/ru/docs/RELEASE_CHECKLIST.md b/docs/i18n/ru/docs/ops/RELEASE_CHECKLIST.md similarity index 94% rename from docs/i18n/ru/docs/RELEASE_CHECKLIST.md rename to docs/i18n/ru/docs/ops/RELEASE_CHECKLIST.md index 71c8666811..5a75c470f4 100644 --- a/docs/i18n/ru/docs/RELEASE_CHECKLIST.md +++ b/docs/i18n/ru/docs/ops/RELEASE_CHECKLIST.md @@ -16,14 +16,14 @@ Use this checklist before tagging or publishing a new OmniRoute release. ## API Docs -1. Update `docs/openapi.yaml`: +1. Update `docs/reference/openapi.yaml`: - `info.version` must equal `package.json` version. 2. Validate endpoint examples if API contracts changed. ## Runtime Docs -1. Review `docs/ARCHITECTURE.md` for storage/runtime drift. -2. Review `docs/TROUBLESHOOTING.md` for env var and operational drift. +1. Review `docs/architecture/ARCHITECTURE.md` for storage/runtime drift. +2. Review `docs/guides/TROUBLESHOOTING.md` for env var and operational drift. 3. Verify the release/runtime Node.js version still satisfies the supported secure floor: - `>=20.20.2 <21` or `>=22.22.2 <23` - `npm run check:node-runtime` diff --git a/docs/i18n/ru/docs/VM_DEPLOYMENT_GUIDE.md b/docs/i18n/ru/docs/ops/VM_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/ru/docs/VM_DEPLOYMENT_GUIDE.md rename to docs/i18n/ru/docs/ops/VM_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/ru/docs/API_REFERENCE.md b/docs/i18n/ru/docs/reference/API_REFERENCE.md similarity index 100% rename from docs/i18n/ru/docs/API_REFERENCE.md rename to docs/i18n/ru/docs/reference/API_REFERENCE.md diff --git a/docs/i18n/ru/docs/CLI-TOOLS.md b/docs/i18n/ru/docs/reference/CLI-TOOLS.md similarity index 100% rename from docs/i18n/ru/docs/CLI-TOOLS.md rename to docs/i18n/ru/docs/reference/CLI-TOOLS.md diff --git a/docs/i18n/ru/docs/ENVIRONMENT.md b/docs/i18n/ru/docs/reference/ENVIRONMENT.md similarity index 100% rename from docs/i18n/ru/docs/ENVIRONMENT.md rename to docs/i18n/ru/docs/reference/ENVIRONMENT.md diff --git a/docs/i18n/ru/docs/AUTO-COMBO.md b/docs/i18n/ru/docs/routing/AUTO-COMBO.md similarity index 100% rename from docs/i18n/ru/docs/AUTO-COMBO.md rename to docs/i18n/ru/docs/routing/AUTO-COMBO.md diff --git a/docs/i18n/ru/llm.txt b/docs/i18n/ru/llm.txt index 05de9ed5e8..a523e0186d 100644 --- a/docs/i18n/ru/llm.txt +++ b/docs/i18n/ru/llm.txt @@ -357,11 +357,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### MCP Server (37 Tools) | Category | Tools | |------------|-------| -| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/MCP-SERVER.md` for full inventory) | +| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/frameworks/MCP-SERVER.md` for full inventory) | | Memory (3) | `memory_search`, `memory_add`, `memory_clear` | | Skills (4) | `skills_list`, `skills_enable`, `skills_execute`, `skills_executions` | -**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/MCP-SERVER.md`. +**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/frameworks/MCP-SERVER.md`. ### Provider Categories @@ -472,7 +472,7 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo 20. **Guardrails framework** in `src/lib/guardrails/` — hot-reloadable registry. Built-ins (priority-ordered): `vision-bridge` (5) → `pii-masker` (10) → `prompt-injection` (20). Fail-open model: exceptions never block traffic. Per-request opt-out via `x-omniroute-disabled-guardrails` header. -21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/AUTHZ_GUIDE.md`. +21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/architecture/AUTHZ_GUIDE.md`. 22. **Three resilience layers** are distinct (do not conflate them): - **Provider Circuit Breaker** (`src/shared/utils/circuitBreaker.ts`) — whole-provider scope. @@ -489,11 +489,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo - **MCP server expanded to 37 tools** (30 base + 3 memory + 4 skills) across ~13 scopes - **OAuth providers expanded to 14**: added Qwen, Kiro, Qoder, Gemini, Windsurf, GitLab Duo - **Coverage gate raised to 75/75/75/70** (was 60% across the board) — measured ~82% -- **Reasoning replay** (`docs/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams +- **Reasoning replay** (`docs/routing/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams - **Compliance + Evals + Webhooks** documentation introduced -- **Stealth guide** (`docs/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration -- **Tunnels guide** (`docs/TUNNELS_GUIDE.md`) — Cloudflare tunnel management -- **Electron guide** (`docs/ELECTRON_GUIDE.md`) — desktop app build + signing +- **Stealth guide** (`docs/security/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration +- **Tunnels guide** (`docs/ops/TUNNELS_GUIDE.md`) — Cloudflare tunnel management +- **Electron guide** (`docs/guides/ELECTRON_GUIDE.md`) — desktop app build + signing ## Links @@ -505,11 +505,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### Documentation Index -- **Architecture & Reference**: `docs/ARCHITECTURE.md`, `docs/CODEBASE_DOCUMENTATION.md`, `docs/REPOSITORY_MAP.md`, `docs/API_REFERENCE.md`, `docs/PROVIDER_REFERENCE.md`, `docs/openapi.yaml` -- **Operator guides**: `docs/USER_GUIDE.md`, `docs/CLI-TOOLS.md`, `docs/TROUBLESHOOTING.md`, `docs/COVERAGE_PLAN.md` -- **Protocols**: `docs/MCP-SERVER.md`, `docs/A2A-SERVER.md`, `docs/AGENT_PROTOCOLS_GUIDE.md`, `docs/CLOUD_AGENT.md` -- **Routing & resilience**: `docs/AUTO-COMBO.md`, `docs/RESILIENCE_GUIDE.md` -- **Security**: `docs/AUTHZ_GUIDE.md`, `docs/GUARDRAILS.md`, `docs/COMPLIANCE.md`, `docs/STEALTH_GUIDE.md` -- **Extensibility**: `docs/SKILLS.md`, `docs/MEMORY.md`, `docs/EVALS.md`, `docs/WEBHOOKS.md`, `docs/REASONING_REPLAY.md` -- **Platform**: `docs/ELECTRON_GUIDE.md`, `docs/TUNNELS_GUIDE.md` +- **Architecture & Reference**: `docs/architecture/ARCHITECTURE.md`, `docs/architecture/CODEBASE_DOCUMENTATION.md`, `docs/architecture/REPOSITORY_MAP.md`, `docs/reference/API_REFERENCE.md`, `docs/reference/PROVIDER_REFERENCE.md`, `docs/reference/openapi.yaml` +- **Operator guides**: `docs/guides/USER_GUIDE.md`, `docs/reference/CLI-TOOLS.md`, `docs/guides/TROUBLESHOOTING.md`, `docs/ops/COVERAGE_PLAN.md` +- **Protocols**: `docs/frameworks/MCP-SERVER.md`, `docs/frameworks/A2A-SERVER.md`, `docs/frameworks/AGENT_PROTOCOLS_GUIDE.md`, `docs/frameworks/CLOUD_AGENT.md` +- **Routing & resilience**: `docs/routing/AUTO-COMBO.md`, `docs/architecture/RESILIENCE_GUIDE.md` +- **Security**: `docs/architecture/AUTHZ_GUIDE.md`, `docs/security/GUARDRAILS.md`, `docs/security/COMPLIANCE.md`, `docs/security/STEALTH_GUIDE.md` +- **Extensibility**: `docs/frameworks/SKILLS.md`, `docs/frameworks/MEMORY.md`, `docs/frameworks/EVALS.md`, `docs/frameworks/WEBHOOKS.md`, `docs/routing/REASONING_REPLAY.md` +- **Platform**: `docs/guides/ELECTRON_GUIDE.md`, `docs/ops/TUNNELS_GUIDE.md` - **AI agents**: `CLAUDE.md`, `AGENTS.md`, `GEMINI.md` diff --git a/docs/i18n/sk/CHANGELOG.md b/docs/i18n/sk/CHANGELOG.md index 4a39586fb5..ea1db32aa7 100644 --- a/docs/i18n/sk/CHANGELOG.md +++ b/docs/i18n/sk/CHANGELOG.md @@ -1310,7 +1310,7 @@ We identified that **155 community PRs** across the entire project history (from - **33 New API Key Providers:** Massive provider expansion adding DeepInfra, Vercel AI Gateway, Lambda AI, SambaNova, nScale, OVHcloud AI, Baseten, PublicAI, Moonshot AI, Meta Llama API, v0 (Vercel), Morph, Featherless AI, FriendliAI, LlamaGate, Galadriel, Weights & Biases Inference, Volcengine, AI21 Labs, Venice.ai, Codestral, Upstage, Maritalk, Xiaomi MiMo, Inference.net, NanoGPT, Predibase, Bytez, Heroku AI, Databricks, Snowflake Cortex, and GigaChat (Sber). OmniRoute now supports **100+ providers** (4 Free + 8 OAuth + 91 API Key + Custom compatible) - **Global Email Privacy Toggle:** Added a persistent eye-icon toggle button across all dashboard pages (Providers, Usage Limits, Playground) that reveals or hides masked email addresses. Toggle state is stored in localStorage and synced globally via Zustand store - **Documentation Refresh:** Updated README, ARCHITECTURE, FEATURES, AGENTS.md, and API_REFERENCE for v3.6.2 with accurate provider counts (100+), new executor list, and system API documentation -- **Uninstall Guide:** Created comprehensive `docs/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) +- **Uninstall Guide:** Created comprehensive `docs/guides/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) ### 🐛 Bug Fixes diff --git a/docs/i18n/sk/CONTRIBUTING.md b/docs/i18n/sk/CONTRIBUTING.md index bd838f7196..677750df6f 100644 --- a/docs/i18n/sk/CONTRIBUTING.md +++ b/docs/i18n/sk/CONTRIBUTING.md @@ -153,7 +153,7 @@ Coverage notes: - If a PR changes production code in `src/`, `open-sse/`, `electron/`, or `bin/`, it must add or update automated tests in the same PR - `npm run coverage:report` prints the detailed file-by-file report from the latest coverage run - `npm run test:coverage:legacy` preserves the older metric for historical comparison -- See `docs/COVERAGE_PLAN.md` for the phased coverage improvement roadmap +- See `docs/ops/COVERAGE_PLAN.md` for the phased coverage improvement roadmap ### Pull Request Requirements @@ -305,7 +305,7 @@ Releases are managed via the `/generate-release` workflow. When a new GitHub Rel ## Getting Help -- **Architecture**: See [`docs/ARCHITECTURE.md`](docs/ARCHITECTURE.md) -- **API Reference**: See [`docs/API_REFERENCE.md`](docs/API_REFERENCE.md) +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](docs/architecture/ARCHITECTURE.md) +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](docs/reference/API_REFERENCE.md) - **Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) - **ADRs**: See `docs/adr/` for architectural decision records diff --git a/docs/i18n/sk/README.md b/docs/i18n/sk/README.md index aa3c743a3d..acb0194cec 100644 --- a/docs/i18n/sk/README.md +++ b/docs/i18n/sk/README.md @@ -2267,25 +2267,25 @@ Se não quiser criar credenciais próprias agora, ainda é possível usar o flux ## Dokumentácia -| Document | Description | -| -------------------------------------------------------- | --------------------------------------------------- | -| [User Guide](docs/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | -| [API Reference](docs/API_REFERENCE.md) | All endpoints with examples | -| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | -| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | -| [Auto-Combo Engine](docs/AUTO-COMBO.md) | 6-factor scoring, mode packs, self-healing | -| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | -| [Troubleshooting](docs/TROUBLESHOOTING.md) | Common problems and solutions | -| [Architecture](docs/ARCHITECTURE.md) | System architecture and internals | -| [Codebase Documentation](docs/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | -| [Uninstall Guide](docs/UNINSTALL.md) | Clean removal for all install methods | -| [Environment Config](docs/ENVIRONMENT.md) | Complete `.env` variables and references | -| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | -| [OpenAPI Spec](docs/openapi.yaml) | OpenAPI 3.0 specification | -| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | -| [VM Deployment](docs/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | -| [Features Gallery](docs/FEATURES.md) | Visual dashboard tour with screenshots | -| [Release Checklist](docs/RELEASE_CHECKLIST.md) | Pre-release validation steps | +| Document | Description | +| --------------------------------------------------------------------- | --------------------------------------------------- | +| [User Guide](docs/guides/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | +| [API Reference](docs/reference/API_REFERENCE.md) | All endpoints with examples | +| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | +| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | +| [Auto-Combo Engine](docs/routing/AUTO-COMBO.md) | 6-factor scoring, mode packs, self-healing | +| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | +| [Troubleshooting](docs/guides/TROUBLESHOOTING.md) | Common problems and solutions | +| [Architecture](docs/architecture/ARCHITECTURE.md) | System architecture and internals | +| [Codebase Documentation](docs/architecture/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | +| [Uninstall Guide](docs/guides/UNINSTALL.md) | Clean removal for all install methods | +| [Environment Config](docs/reference/ENVIRONMENT.md) | Complete `.env` variables and references | +| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | +| [OpenAPI Spec](docs/reference/openapi.yaml) | OpenAPI 3.0 specification | +| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | +| [VM Deployment](docs/ops/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | +| [Features Gallery](docs/guides/FEATURES.md) | Visual dashboard tour with screenshots | +| [Release Checklist](docs/ops/RELEASE_CHECKLIST.md) | Pre-release validation steps | --- diff --git a/docs/i18n/sk/docs/ARCHITECTURE.md b/docs/i18n/sk/docs/architecture/ARCHITECTURE.md similarity index 100% rename from docs/i18n/sk/docs/ARCHITECTURE.md rename to docs/i18n/sk/docs/architecture/ARCHITECTURE.md diff --git a/docs/i18n/sk/docs/CODEBASE_DOCUMENTATION.md b/docs/i18n/sk/docs/architecture/CODEBASE_DOCUMENTATION.md similarity index 100% rename from docs/i18n/sk/docs/CODEBASE_DOCUMENTATION.md rename to docs/i18n/sk/docs/architecture/CODEBASE_DOCUMENTATION.md diff --git a/docs/i18n/sk/docs/A2A-SERVER.md b/docs/i18n/sk/docs/frameworks/A2A-SERVER.md similarity index 100% rename from docs/i18n/sk/docs/A2A-SERVER.md rename to docs/i18n/sk/docs/frameworks/A2A-SERVER.md diff --git a/docs/i18n/sk/docs/MCP-SERVER.md b/docs/i18n/sk/docs/frameworks/MCP-SERVER.md similarity index 100% rename from docs/i18n/sk/docs/MCP-SERVER.md rename to docs/i18n/sk/docs/frameworks/MCP-SERVER.md diff --git a/docs/i18n/sk/docs/FEATURES.md b/docs/i18n/sk/docs/guides/FEATURES.md similarity index 100% rename from docs/i18n/sk/docs/FEATURES.md rename to docs/i18n/sk/docs/guides/FEATURES.md diff --git a/docs/i18n/sk/docs/I18N.md b/docs/i18n/sk/docs/guides/I18N.md similarity index 99% rename from docs/i18n/sk/docs/I18N.md rename to docs/i18n/sk/docs/guides/I18N.md index 730fb28193..a606ffe0a0 100644 --- a/docs/i18n/sk/docs/I18N.md +++ b/docs/i18n/sk/docs/guides/I18N.md @@ -420,7 +420,7 @@ The generator originally used `code: "in"` (deprecated Google Translate code) fo ### `docs/i18n/README.md` Is Auto-Generated -The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/I18N.md` (this file) for hand-written documentation that should persist. +The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/guides/I18N.md` (this file) for hand-written documentation that should persist. ### External Untranslatable Keys List diff --git a/docs/i18n/sk/docs/TROUBLESHOOTING.md b/docs/i18n/sk/docs/guides/TROUBLESHOOTING.md similarity index 98% rename from docs/i18n/sk/docs/TROUBLESHOOTING.md rename to docs/i18n/sk/docs/guides/TROUBLESHOOTING.md index cc0df932fd..69e37c671d 100644 --- a/docs/i18n/sk/docs/TROUBLESHOOTING.md +++ b/docs/i18n/sk/docs/guides/TROUBLESHOOTING.md @@ -335,7 +335,7 @@ You can ignore this section if you do not run RAG or agent pipelines behind Omni ## Still Stuck? - **GitHub Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) -- **Architecture**: See [`docs/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details -- **API Reference**: See [`docs/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints - **Health Dashboard**: Check **Dashboard → Health** for real-time system status - **Translator**: Use **Dashboard → Translator** to debug format issues diff --git a/docs/i18n/sk/docs/UNINSTALL.md b/docs/i18n/sk/docs/guides/UNINSTALL.md similarity index 100% rename from docs/i18n/sk/docs/UNINSTALL.md rename to docs/i18n/sk/docs/guides/UNINSTALL.md diff --git a/docs/i18n/sk/docs/USER_GUIDE.md b/docs/i18n/sk/docs/guides/USER_GUIDE.md similarity index 100% rename from docs/i18n/sk/docs/USER_GUIDE.md rename to docs/i18n/sk/docs/guides/USER_GUIDE.md diff --git a/docs/i18n/sk/docs/COVERAGE_PLAN.md b/docs/i18n/sk/docs/ops/COVERAGE_PLAN.md similarity index 100% rename from docs/i18n/sk/docs/COVERAGE_PLAN.md rename to docs/i18n/sk/docs/ops/COVERAGE_PLAN.md diff --git a/docs/i18n/sk/docs/FLY_IO_DEPLOYMENT_GUIDE.md b/docs/i18n/sk/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/sk/docs/FLY_IO_DEPLOYMENT_GUIDE.md rename to docs/i18n/sk/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/sk/docs/RELEASE_CHECKLIST.md b/docs/i18n/sk/docs/ops/RELEASE_CHECKLIST.md similarity index 94% rename from docs/i18n/sk/docs/RELEASE_CHECKLIST.md rename to docs/i18n/sk/docs/ops/RELEASE_CHECKLIST.md index 9ed21278c1..80ec87e341 100644 --- a/docs/i18n/sk/docs/RELEASE_CHECKLIST.md +++ b/docs/i18n/sk/docs/ops/RELEASE_CHECKLIST.md @@ -16,14 +16,14 @@ Use this checklist before tagging or publishing a new OmniRoute release. ## API Docs -1. Update `docs/openapi.yaml`: +1. Update `docs/reference/openapi.yaml`: - `info.version` must equal `package.json` version. 2. Validate endpoint examples if API contracts changed. ## Runtime Docs -1. Review `docs/ARCHITECTURE.md` for storage/runtime drift. -2. Review `docs/TROUBLESHOOTING.md` for env var and operational drift. +1. Review `docs/architecture/ARCHITECTURE.md` for storage/runtime drift. +2. Review `docs/guides/TROUBLESHOOTING.md` for env var and operational drift. 3. Verify the release/runtime Node.js version still satisfies the supported secure floor: - `>=20.20.2 <21` or `>=22.22.2 <23` - `npm run check:node-runtime` diff --git a/docs/i18n/sk/docs/VM_DEPLOYMENT_GUIDE.md b/docs/i18n/sk/docs/ops/VM_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/sk/docs/VM_DEPLOYMENT_GUIDE.md rename to docs/i18n/sk/docs/ops/VM_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/sk/docs/API_REFERENCE.md b/docs/i18n/sk/docs/reference/API_REFERENCE.md similarity index 100% rename from docs/i18n/sk/docs/API_REFERENCE.md rename to docs/i18n/sk/docs/reference/API_REFERENCE.md diff --git a/docs/i18n/sk/docs/CLI-TOOLS.md b/docs/i18n/sk/docs/reference/CLI-TOOLS.md similarity index 100% rename from docs/i18n/sk/docs/CLI-TOOLS.md rename to docs/i18n/sk/docs/reference/CLI-TOOLS.md diff --git a/docs/i18n/sk/docs/ENVIRONMENT.md b/docs/i18n/sk/docs/reference/ENVIRONMENT.md similarity index 100% rename from docs/i18n/sk/docs/ENVIRONMENT.md rename to docs/i18n/sk/docs/reference/ENVIRONMENT.md diff --git a/docs/i18n/sk/docs/AUTO-COMBO.md b/docs/i18n/sk/docs/routing/AUTO-COMBO.md similarity index 100% rename from docs/i18n/sk/docs/AUTO-COMBO.md rename to docs/i18n/sk/docs/routing/AUTO-COMBO.md diff --git a/docs/i18n/sk/llm.txt b/docs/i18n/sk/llm.txt index a52e4424f0..6bf44b5000 100644 --- a/docs/i18n/sk/llm.txt +++ b/docs/i18n/sk/llm.txt @@ -357,11 +357,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### MCP Server (37 Tools) | Category | Tools | |------------|-------| -| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/MCP-SERVER.md` for full inventory) | +| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/frameworks/MCP-SERVER.md` for full inventory) | | Memory (3) | `memory_search`, `memory_add`, `memory_clear` | | Skills (4) | `skills_list`, `skills_enable`, `skills_execute`, `skills_executions` | -**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/MCP-SERVER.md`. +**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/frameworks/MCP-SERVER.md`. ### Provider Categories @@ -472,7 +472,7 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo 20. **Guardrails framework** in `src/lib/guardrails/` — hot-reloadable registry. Built-ins (priority-ordered): `vision-bridge` (5) → `pii-masker` (10) → `prompt-injection` (20). Fail-open model: exceptions never block traffic. Per-request opt-out via `x-omniroute-disabled-guardrails` header. -21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/AUTHZ_GUIDE.md`. +21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/architecture/AUTHZ_GUIDE.md`. 22. **Three resilience layers** are distinct (do not conflate them): - **Provider Circuit Breaker** (`src/shared/utils/circuitBreaker.ts`) — whole-provider scope. @@ -489,11 +489,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo - **MCP server expanded to 37 tools** (30 base + 3 memory + 4 skills) across ~13 scopes - **OAuth providers expanded to 14**: added Qwen, Kiro, Qoder, Gemini, Windsurf, GitLab Duo - **Coverage gate raised to 75/75/75/70** (was 60% across the board) — measured ~82% -- **Reasoning replay** (`docs/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams +- **Reasoning replay** (`docs/routing/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams - **Compliance + Evals + Webhooks** documentation introduced -- **Stealth guide** (`docs/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration -- **Tunnels guide** (`docs/TUNNELS_GUIDE.md`) — Cloudflare tunnel management -- **Electron guide** (`docs/ELECTRON_GUIDE.md`) — desktop app build + signing +- **Stealth guide** (`docs/security/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration +- **Tunnels guide** (`docs/ops/TUNNELS_GUIDE.md`) — Cloudflare tunnel management +- **Electron guide** (`docs/guides/ELECTRON_GUIDE.md`) — desktop app build + signing ## Links @@ -505,11 +505,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### Documentation Index -- **Architecture & Reference**: `docs/ARCHITECTURE.md`, `docs/CODEBASE_DOCUMENTATION.md`, `docs/REPOSITORY_MAP.md`, `docs/API_REFERENCE.md`, `docs/PROVIDER_REFERENCE.md`, `docs/openapi.yaml` -- **Operator guides**: `docs/USER_GUIDE.md`, `docs/CLI-TOOLS.md`, `docs/TROUBLESHOOTING.md`, `docs/COVERAGE_PLAN.md` -- **Protocols**: `docs/MCP-SERVER.md`, `docs/A2A-SERVER.md`, `docs/AGENT_PROTOCOLS_GUIDE.md`, `docs/CLOUD_AGENT.md` -- **Routing & resilience**: `docs/AUTO-COMBO.md`, `docs/RESILIENCE_GUIDE.md` -- **Security**: `docs/AUTHZ_GUIDE.md`, `docs/GUARDRAILS.md`, `docs/COMPLIANCE.md`, `docs/STEALTH_GUIDE.md` -- **Extensibility**: `docs/SKILLS.md`, `docs/MEMORY.md`, `docs/EVALS.md`, `docs/WEBHOOKS.md`, `docs/REASONING_REPLAY.md` -- **Platform**: `docs/ELECTRON_GUIDE.md`, `docs/TUNNELS_GUIDE.md` +- **Architecture & Reference**: `docs/architecture/ARCHITECTURE.md`, `docs/architecture/CODEBASE_DOCUMENTATION.md`, `docs/architecture/REPOSITORY_MAP.md`, `docs/reference/API_REFERENCE.md`, `docs/reference/PROVIDER_REFERENCE.md`, `docs/reference/openapi.yaml` +- **Operator guides**: `docs/guides/USER_GUIDE.md`, `docs/reference/CLI-TOOLS.md`, `docs/guides/TROUBLESHOOTING.md`, `docs/ops/COVERAGE_PLAN.md` +- **Protocols**: `docs/frameworks/MCP-SERVER.md`, `docs/frameworks/A2A-SERVER.md`, `docs/frameworks/AGENT_PROTOCOLS_GUIDE.md`, `docs/frameworks/CLOUD_AGENT.md` +- **Routing & resilience**: `docs/routing/AUTO-COMBO.md`, `docs/architecture/RESILIENCE_GUIDE.md` +- **Security**: `docs/architecture/AUTHZ_GUIDE.md`, `docs/security/GUARDRAILS.md`, `docs/security/COMPLIANCE.md`, `docs/security/STEALTH_GUIDE.md` +- **Extensibility**: `docs/frameworks/SKILLS.md`, `docs/frameworks/MEMORY.md`, `docs/frameworks/EVALS.md`, `docs/frameworks/WEBHOOKS.md`, `docs/routing/REASONING_REPLAY.md` +- **Platform**: `docs/guides/ELECTRON_GUIDE.md`, `docs/ops/TUNNELS_GUIDE.md` - **AI agents**: `CLAUDE.md`, `AGENTS.md`, `GEMINI.md` diff --git a/docs/i18n/sv/CHANGELOG.md b/docs/i18n/sv/CHANGELOG.md index c5ea260133..4baacbf190 100644 --- a/docs/i18n/sv/CHANGELOG.md +++ b/docs/i18n/sv/CHANGELOG.md @@ -1310,7 +1310,7 @@ We identified that **155 community PRs** across the entire project history (from - **33 New API Key Providers:** Massive provider expansion adding DeepInfra, Vercel AI Gateway, Lambda AI, SambaNova, nScale, OVHcloud AI, Baseten, PublicAI, Moonshot AI, Meta Llama API, v0 (Vercel), Morph, Featherless AI, FriendliAI, LlamaGate, Galadriel, Weights & Biases Inference, Volcengine, AI21 Labs, Venice.ai, Codestral, Upstage, Maritalk, Xiaomi MiMo, Inference.net, NanoGPT, Predibase, Bytez, Heroku AI, Databricks, Snowflake Cortex, and GigaChat (Sber). OmniRoute now supports **100+ providers** (4 Free + 8 OAuth + 91 API Key + Custom compatible) - **Global Email Privacy Toggle:** Added a persistent eye-icon toggle button across all dashboard pages (Providers, Usage Limits, Playground) that reveals or hides masked email addresses. Toggle state is stored in localStorage and synced globally via Zustand store - **Documentation Refresh:** Updated README, ARCHITECTURE, FEATURES, AGENTS.md, and API_REFERENCE for v3.6.2 with accurate provider counts (100+), new executor list, and system API documentation -- **Uninstall Guide:** Created comprehensive `docs/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) +- **Uninstall Guide:** Created comprehensive `docs/guides/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) ### 🐛 Bug Fixes diff --git a/docs/i18n/sv/CONTRIBUTING.md b/docs/i18n/sv/CONTRIBUTING.md index badf89519f..6509c1f5c3 100644 --- a/docs/i18n/sv/CONTRIBUTING.md +++ b/docs/i18n/sv/CONTRIBUTING.md @@ -153,7 +153,7 @@ Coverage notes: - If a PR changes production code in `src/`, `open-sse/`, `electron/`, or `bin/`, it must add or update automated tests in the same PR - `npm run coverage:report` prints the detailed file-by-file report from the latest coverage run - `npm run test:coverage:legacy` preserves the older metric for historical comparison -- See `docs/COVERAGE_PLAN.md` for the phased coverage improvement roadmap +- See `docs/ops/COVERAGE_PLAN.md` for the phased coverage improvement roadmap ### Pull Request Requirements @@ -305,7 +305,7 @@ Releases are managed via the `/generate-release` workflow. When a new GitHub Rel ## Getting Help -- **Architecture**: See [`docs/ARCHITECTURE.md`](docs/ARCHITECTURE.md) -- **API Reference**: See [`docs/API_REFERENCE.md`](docs/API_REFERENCE.md) +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](docs/architecture/ARCHITECTURE.md) +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](docs/reference/API_REFERENCE.md) - **Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) - **ADRs**: See `docs/adr/` for architectural decision records diff --git a/docs/i18n/sv/README.md b/docs/i18n/sv/README.md index 298d243955..887ef03464 100644 --- a/docs/i18n/sv/README.md +++ b/docs/i18n/sv/README.md @@ -2267,25 +2267,25 @@ Se não quiser criar credenciais próprias agora, ainda é possível usar o flux ## Dokumentation -| Document | Description | -| -------------------------------------------------------- | --------------------------------------------------- | -| [User Guide](docs/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | -| [API Reference](docs/API_REFERENCE.md) | All endpoints with examples | -| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | -| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | -| [Auto-Combo Engine](docs/AUTO-COMBO.md) | 6-factor scoring, mode packs, self-healing | -| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | -| [Troubleshooting](docs/TROUBLESHOOTING.md) | Common problems and solutions | -| [Architecture](docs/ARCHITECTURE.md) | System architecture and internals | -| [Codebase Documentation](docs/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | -| [Uninstall Guide](docs/UNINSTALL.md) | Clean removal for all install methods | -| [Environment Config](docs/ENVIRONMENT.md) | Complete `.env` variables and references | -| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | -| [OpenAPI Spec](docs/openapi.yaml) | OpenAPI 3.0 specification | -| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | -| [VM Deployment](docs/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | -| [Features Gallery](docs/FEATURES.md) | Visual dashboard tour with screenshots | -| [Release Checklist](docs/RELEASE_CHECKLIST.md) | Pre-release validation steps | +| Document | Description | +| --------------------------------------------------------------------- | --------------------------------------------------- | +| [User Guide](docs/guides/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | +| [API Reference](docs/reference/API_REFERENCE.md) | All endpoints with examples | +| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | +| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | +| [Auto-Combo Engine](docs/routing/AUTO-COMBO.md) | 6-factor scoring, mode packs, self-healing | +| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | +| [Troubleshooting](docs/guides/TROUBLESHOOTING.md) | Common problems and solutions | +| [Architecture](docs/architecture/ARCHITECTURE.md) | System architecture and internals | +| [Codebase Documentation](docs/architecture/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | +| [Uninstall Guide](docs/guides/UNINSTALL.md) | Clean removal for all install methods | +| [Environment Config](docs/reference/ENVIRONMENT.md) | Complete `.env` variables and references | +| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | +| [OpenAPI Spec](docs/reference/openapi.yaml) | OpenAPI 3.0 specification | +| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | +| [VM Deployment](docs/ops/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | +| [Features Gallery](docs/guides/FEATURES.md) | Visual dashboard tour with screenshots | +| [Release Checklist](docs/ops/RELEASE_CHECKLIST.md) | Pre-release validation steps | --- diff --git a/docs/i18n/sv/docs/ARCHITECTURE.md b/docs/i18n/sv/docs/architecture/ARCHITECTURE.md similarity index 100% rename from docs/i18n/sv/docs/ARCHITECTURE.md rename to docs/i18n/sv/docs/architecture/ARCHITECTURE.md diff --git a/docs/i18n/sv/docs/CODEBASE_DOCUMENTATION.md b/docs/i18n/sv/docs/architecture/CODEBASE_DOCUMENTATION.md similarity index 100% rename from docs/i18n/sv/docs/CODEBASE_DOCUMENTATION.md rename to docs/i18n/sv/docs/architecture/CODEBASE_DOCUMENTATION.md diff --git a/docs/i18n/sv/docs/A2A-SERVER.md b/docs/i18n/sv/docs/frameworks/A2A-SERVER.md similarity index 100% rename from docs/i18n/sv/docs/A2A-SERVER.md rename to docs/i18n/sv/docs/frameworks/A2A-SERVER.md diff --git a/docs/i18n/sv/docs/MCP-SERVER.md b/docs/i18n/sv/docs/frameworks/MCP-SERVER.md similarity index 100% rename from docs/i18n/sv/docs/MCP-SERVER.md rename to docs/i18n/sv/docs/frameworks/MCP-SERVER.md diff --git a/docs/i18n/sv/docs/FEATURES.md b/docs/i18n/sv/docs/guides/FEATURES.md similarity index 100% rename from docs/i18n/sv/docs/FEATURES.md rename to docs/i18n/sv/docs/guides/FEATURES.md diff --git a/docs/i18n/sv/docs/I18N.md b/docs/i18n/sv/docs/guides/I18N.md similarity index 99% rename from docs/i18n/sv/docs/I18N.md rename to docs/i18n/sv/docs/guides/I18N.md index fb4cc6724e..327e647112 100644 --- a/docs/i18n/sv/docs/I18N.md +++ b/docs/i18n/sv/docs/guides/I18N.md @@ -420,7 +420,7 @@ The generator originally used `code: "in"` (deprecated Google Translate code) fo ### `docs/i18n/README.md` Is Auto-Generated -The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/I18N.md` (this file) for hand-written documentation that should persist. +The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/guides/I18N.md` (this file) for hand-written documentation that should persist. ### External Untranslatable Keys List diff --git a/docs/i18n/sv/docs/TROUBLESHOOTING.md b/docs/i18n/sv/docs/guides/TROUBLESHOOTING.md similarity index 98% rename from docs/i18n/sv/docs/TROUBLESHOOTING.md rename to docs/i18n/sv/docs/guides/TROUBLESHOOTING.md index f9d04efd71..aafabe2f6f 100644 --- a/docs/i18n/sv/docs/TROUBLESHOOTING.md +++ b/docs/i18n/sv/docs/guides/TROUBLESHOOTING.md @@ -335,7 +335,7 @@ You can ignore this section if you do not run RAG or agent pipelines behind Omni ## Still Stuck? - **GitHub Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) -- **Architecture**: See [`docs/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details -- **API Reference**: See [`docs/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints - **Health Dashboard**: Check **Dashboard → Health** for real-time system status - **Translator**: Use **Dashboard → Translator** to debug format issues diff --git a/docs/i18n/sv/docs/UNINSTALL.md b/docs/i18n/sv/docs/guides/UNINSTALL.md similarity index 100% rename from docs/i18n/sv/docs/UNINSTALL.md rename to docs/i18n/sv/docs/guides/UNINSTALL.md diff --git a/docs/i18n/sv/docs/USER_GUIDE.md b/docs/i18n/sv/docs/guides/USER_GUIDE.md similarity index 100% rename from docs/i18n/sv/docs/USER_GUIDE.md rename to docs/i18n/sv/docs/guides/USER_GUIDE.md diff --git a/docs/i18n/sv/docs/COVERAGE_PLAN.md b/docs/i18n/sv/docs/ops/COVERAGE_PLAN.md similarity index 100% rename from docs/i18n/sv/docs/COVERAGE_PLAN.md rename to docs/i18n/sv/docs/ops/COVERAGE_PLAN.md diff --git a/docs/i18n/sv/docs/FLY_IO_DEPLOYMENT_GUIDE.md b/docs/i18n/sv/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/sv/docs/FLY_IO_DEPLOYMENT_GUIDE.md rename to docs/i18n/sv/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/sv/docs/RELEASE_CHECKLIST.md b/docs/i18n/sv/docs/ops/RELEASE_CHECKLIST.md similarity index 94% rename from docs/i18n/sv/docs/RELEASE_CHECKLIST.md rename to docs/i18n/sv/docs/ops/RELEASE_CHECKLIST.md index 27a3be9488..8d03464d6e 100644 --- a/docs/i18n/sv/docs/RELEASE_CHECKLIST.md +++ b/docs/i18n/sv/docs/ops/RELEASE_CHECKLIST.md @@ -16,14 +16,14 @@ Use this checklist before tagging or publishing a new OmniRoute release. ## API Docs -1. Update `docs/openapi.yaml`: +1. Update `docs/reference/openapi.yaml`: - `info.version` must equal `package.json` version. 2. Validate endpoint examples if API contracts changed. ## Runtime Docs -1. Review `docs/ARCHITECTURE.md` for storage/runtime drift. -2. Review `docs/TROUBLESHOOTING.md` for env var and operational drift. +1. Review `docs/architecture/ARCHITECTURE.md` for storage/runtime drift. +2. Review `docs/guides/TROUBLESHOOTING.md` for env var and operational drift. 3. Verify the release/runtime Node.js version still satisfies the supported secure floor: - `>=20.20.2 <21` or `>=22.22.2 <23` - `npm run check:node-runtime` diff --git a/docs/i18n/sv/docs/VM_DEPLOYMENT_GUIDE.md b/docs/i18n/sv/docs/ops/VM_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/sv/docs/VM_DEPLOYMENT_GUIDE.md rename to docs/i18n/sv/docs/ops/VM_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/sv/docs/API_REFERENCE.md b/docs/i18n/sv/docs/reference/API_REFERENCE.md similarity index 100% rename from docs/i18n/sv/docs/API_REFERENCE.md rename to docs/i18n/sv/docs/reference/API_REFERENCE.md diff --git a/docs/i18n/sv/docs/CLI-TOOLS.md b/docs/i18n/sv/docs/reference/CLI-TOOLS.md similarity index 100% rename from docs/i18n/sv/docs/CLI-TOOLS.md rename to docs/i18n/sv/docs/reference/CLI-TOOLS.md diff --git a/docs/i18n/sv/docs/ENVIRONMENT.md b/docs/i18n/sv/docs/reference/ENVIRONMENT.md similarity index 100% rename from docs/i18n/sv/docs/ENVIRONMENT.md rename to docs/i18n/sv/docs/reference/ENVIRONMENT.md diff --git a/docs/i18n/sv/docs/AUTO-COMBO.md b/docs/i18n/sv/docs/routing/AUTO-COMBO.md similarity index 100% rename from docs/i18n/sv/docs/AUTO-COMBO.md rename to docs/i18n/sv/docs/routing/AUTO-COMBO.md diff --git a/docs/i18n/sv/llm.txt b/docs/i18n/sv/llm.txt index 9763509bf5..07e2cebb81 100644 --- a/docs/i18n/sv/llm.txt +++ b/docs/i18n/sv/llm.txt @@ -357,11 +357,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### MCP Server (37 Tools) | Category | Tools | |------------|-------| -| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/MCP-SERVER.md` for full inventory) | +| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/frameworks/MCP-SERVER.md` for full inventory) | | Memory (3) | `memory_search`, `memory_add`, `memory_clear` | | Skills (4) | `skills_list`, `skills_enable`, `skills_execute`, `skills_executions` | -**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/MCP-SERVER.md`. +**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/frameworks/MCP-SERVER.md`. ### Provider Categories @@ -472,7 +472,7 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo 20. **Guardrails framework** in `src/lib/guardrails/` — hot-reloadable registry. Built-ins (priority-ordered): `vision-bridge` (5) → `pii-masker` (10) → `prompt-injection` (20). Fail-open model: exceptions never block traffic. Per-request opt-out via `x-omniroute-disabled-guardrails` header. -21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/AUTHZ_GUIDE.md`. +21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/architecture/AUTHZ_GUIDE.md`. 22. **Three resilience layers** are distinct (do not conflate them): - **Provider Circuit Breaker** (`src/shared/utils/circuitBreaker.ts`) — whole-provider scope. @@ -489,11 +489,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo - **MCP server expanded to 37 tools** (30 base + 3 memory + 4 skills) across ~13 scopes - **OAuth providers expanded to 14**: added Qwen, Kiro, Qoder, Gemini, Windsurf, GitLab Duo - **Coverage gate raised to 75/75/75/70** (was 60% across the board) — measured ~82% -- **Reasoning replay** (`docs/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams +- **Reasoning replay** (`docs/routing/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams - **Compliance + Evals + Webhooks** documentation introduced -- **Stealth guide** (`docs/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration -- **Tunnels guide** (`docs/TUNNELS_GUIDE.md`) — Cloudflare tunnel management -- **Electron guide** (`docs/ELECTRON_GUIDE.md`) — desktop app build + signing +- **Stealth guide** (`docs/security/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration +- **Tunnels guide** (`docs/ops/TUNNELS_GUIDE.md`) — Cloudflare tunnel management +- **Electron guide** (`docs/guides/ELECTRON_GUIDE.md`) — desktop app build + signing ## Links @@ -505,11 +505,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### Documentation Index -- **Architecture & Reference**: `docs/ARCHITECTURE.md`, `docs/CODEBASE_DOCUMENTATION.md`, `docs/REPOSITORY_MAP.md`, `docs/API_REFERENCE.md`, `docs/PROVIDER_REFERENCE.md`, `docs/openapi.yaml` -- **Operator guides**: `docs/USER_GUIDE.md`, `docs/CLI-TOOLS.md`, `docs/TROUBLESHOOTING.md`, `docs/COVERAGE_PLAN.md` -- **Protocols**: `docs/MCP-SERVER.md`, `docs/A2A-SERVER.md`, `docs/AGENT_PROTOCOLS_GUIDE.md`, `docs/CLOUD_AGENT.md` -- **Routing & resilience**: `docs/AUTO-COMBO.md`, `docs/RESILIENCE_GUIDE.md` -- **Security**: `docs/AUTHZ_GUIDE.md`, `docs/GUARDRAILS.md`, `docs/COMPLIANCE.md`, `docs/STEALTH_GUIDE.md` -- **Extensibility**: `docs/SKILLS.md`, `docs/MEMORY.md`, `docs/EVALS.md`, `docs/WEBHOOKS.md`, `docs/REASONING_REPLAY.md` -- **Platform**: `docs/ELECTRON_GUIDE.md`, `docs/TUNNELS_GUIDE.md` +- **Architecture & Reference**: `docs/architecture/ARCHITECTURE.md`, `docs/architecture/CODEBASE_DOCUMENTATION.md`, `docs/architecture/REPOSITORY_MAP.md`, `docs/reference/API_REFERENCE.md`, `docs/reference/PROVIDER_REFERENCE.md`, `docs/reference/openapi.yaml` +- **Operator guides**: `docs/guides/USER_GUIDE.md`, `docs/reference/CLI-TOOLS.md`, `docs/guides/TROUBLESHOOTING.md`, `docs/ops/COVERAGE_PLAN.md` +- **Protocols**: `docs/frameworks/MCP-SERVER.md`, `docs/frameworks/A2A-SERVER.md`, `docs/frameworks/AGENT_PROTOCOLS_GUIDE.md`, `docs/frameworks/CLOUD_AGENT.md` +- **Routing & resilience**: `docs/routing/AUTO-COMBO.md`, `docs/architecture/RESILIENCE_GUIDE.md` +- **Security**: `docs/architecture/AUTHZ_GUIDE.md`, `docs/security/GUARDRAILS.md`, `docs/security/COMPLIANCE.md`, `docs/security/STEALTH_GUIDE.md` +- **Extensibility**: `docs/frameworks/SKILLS.md`, `docs/frameworks/MEMORY.md`, `docs/frameworks/EVALS.md`, `docs/frameworks/WEBHOOKS.md`, `docs/routing/REASONING_REPLAY.md` +- **Platform**: `docs/guides/ELECTRON_GUIDE.md`, `docs/ops/TUNNELS_GUIDE.md` - **AI agents**: `CLAUDE.md`, `AGENTS.md`, `GEMINI.md` diff --git a/docs/i18n/sw/CHANGELOG.md b/docs/i18n/sw/CHANGELOG.md index e3c94ea81d..847e10ff90 100644 --- a/docs/i18n/sw/CHANGELOG.md +++ b/docs/i18n/sw/CHANGELOG.md @@ -1310,7 +1310,7 @@ We identified that **155 community PRs** across the entire project history (from - **33 New API Key Providers:** Massive provider expansion adding DeepInfra, Vercel AI Gateway, Lambda AI, SambaNova, nScale, OVHcloud AI, Baseten, PublicAI, Moonshot AI, Meta Llama API, v0 (Vercel), Morph, Featherless AI, FriendliAI, LlamaGate, Galadriel, Weights & Biases Inference, Volcengine, AI21 Labs, Venice.ai, Codestral, Upstage, Maritalk, Xiaomi MiMo, Inference.net, NanoGPT, Predibase, Bytez, Heroku AI, Databricks, Snowflake Cortex, and GigaChat (Sber). OmniRoute now supports **100+ providers** (4 Free + 8 OAuth + 91 API Key + Custom compatible) - **Global Email Privacy Toggle:** Added a persistent eye-icon toggle button across all dashboard pages (Providers, Usage Limits, Playground) that reveals or hides masked email addresses. Toggle state is stored in localStorage and synced globally via Zustand store - **Documentation Refresh:** Updated README, ARCHITECTURE, FEATURES, AGENTS.md, and API_REFERENCE for v3.6.2 with accurate provider counts (100+), new executor list, and system API documentation -- **Uninstall Guide:** Created comprehensive `docs/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) +- **Uninstall Guide:** Created comprehensive `docs/guides/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) ### 🐛 Bug Fixes diff --git a/docs/i18n/sw/CONTRIBUTING.md b/docs/i18n/sw/CONTRIBUTING.md index 165f664ff1..f05d33b53a 100644 --- a/docs/i18n/sw/CONTRIBUTING.md +++ b/docs/i18n/sw/CONTRIBUTING.md @@ -153,7 +153,7 @@ Coverage notes: - If a PR changes production code in `src/`, `open-sse/`, `electron/`, or `bin/`, it must add or update automated tests in the same PR - `npm run coverage:report` prints the detailed file-by-file report from the latest coverage run - `npm run test:coverage:legacy` preserves the older metric for historical comparison -- See `docs/COVERAGE_PLAN.md` for the phased coverage improvement roadmap +- See `docs/ops/COVERAGE_PLAN.md` for the phased coverage improvement roadmap ### Pull Request Requirements @@ -305,7 +305,7 @@ Releases are managed via the `/generate-release` workflow. When a new GitHub Rel ## Getting Help -- **Architecture**: See [`docs/ARCHITECTURE.md`](docs/ARCHITECTURE.md) -- **API Reference**: See [`docs/API_REFERENCE.md`](docs/API_REFERENCE.md) +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](docs/architecture/ARCHITECTURE.md) +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](docs/reference/API_REFERENCE.md) - **Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) - **ADRs**: See `docs/adr/` for architectural decision records diff --git a/docs/i18n/sw/README.md b/docs/i18n/sw/README.md index db067e44ac..3a399c0b72 100644 --- a/docs/i18n/sw/README.md +++ b/docs/i18n/sw/README.md @@ -2267,25 +2267,25 @@ Se não quiser criar credenciais próprias agora, ainda é possível usar o flux ## Documentación -| Document | Description | -| -------------------------------------------------------- | --------------------------------------------------- | -| [User Guide](docs/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | -| [API Reference](docs/API_REFERENCE.md) | All endpoints with examples | -| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | -| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | -| [Auto-Combo Engine](docs/auto-combo.md) | 6-factor scoring, mode packs, self-healing | -| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | -| [Troubleshooting](docs/TROUBLESHOOTING.md) | Common problems and solutions | -| [Architecture](docs/ARCHITECTURE.md) | System architecture and internals | -| [Codebase Documentation](docs/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | -| [Uninstall Guide](docs/UNINSTALL.md) | Clean removal for all install methods | -| [Environment Config](docs/ENVIRONMENT.md) | Complete `.env` variables and references | -| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | -| [OpenAPI Spec](docs/openapi.yaml) | OpenAPI 3.0 specification | -| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | -| [VM Deployment](docs/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | -| [Features Gallery](docs/FEATURES.md) | Visual dashboard tour with screenshots | -| [Release Checklist](docs/RELEASE_CHECKLIST.md) | Pre-release validation steps | +| Document | Description | +| --------------------------------------------------------------------- | --------------------------------------------------- | +| [User Guide](docs/guides/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | +| [API Reference](docs/reference/API_REFERENCE.md) | All endpoints with examples | +| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | +| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | +| [Auto-Combo Engine](docs/auto-combo.md) | 6-factor scoring, mode packs, self-healing | +| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | +| [Troubleshooting](docs/guides/TROUBLESHOOTING.md) | Common problems and solutions | +| [Architecture](docs/architecture/ARCHITECTURE.md) | System architecture and internals | +| [Codebase Documentation](docs/architecture/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | +| [Uninstall Guide](docs/guides/UNINSTALL.md) | Clean removal for all install methods | +| [Environment Config](docs/reference/ENVIRONMENT.md) | Complete `.env` variables and references | +| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | +| [OpenAPI Spec](docs/reference/openapi.yaml) | OpenAPI 3.0 specification | +| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | +| [VM Deployment](docs/ops/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | +| [Features Gallery](docs/guides/FEATURES.md) | Visual dashboard tour with screenshots | +| [Release Checklist](docs/ops/RELEASE_CHECKLIST.md) | Pre-release validation steps | --- diff --git a/docs/i18n/sw/docs/ARCHITECTURE.md b/docs/i18n/sw/docs/architecture/ARCHITECTURE.md similarity index 100% rename from docs/i18n/sw/docs/ARCHITECTURE.md rename to docs/i18n/sw/docs/architecture/ARCHITECTURE.md diff --git a/docs/i18n/sw/docs/CODEBASE_DOCUMENTATION.md b/docs/i18n/sw/docs/architecture/CODEBASE_DOCUMENTATION.md similarity index 100% rename from docs/i18n/sw/docs/CODEBASE_DOCUMENTATION.md rename to docs/i18n/sw/docs/architecture/CODEBASE_DOCUMENTATION.md diff --git a/docs/i18n/sw/docs/A2A-SERVER.md b/docs/i18n/sw/docs/frameworks/A2A-SERVER.md similarity index 100% rename from docs/i18n/sw/docs/A2A-SERVER.md rename to docs/i18n/sw/docs/frameworks/A2A-SERVER.md diff --git a/docs/i18n/sw/docs/MCP-SERVER.md b/docs/i18n/sw/docs/frameworks/MCP-SERVER.md similarity index 100% rename from docs/i18n/sw/docs/MCP-SERVER.md rename to docs/i18n/sw/docs/frameworks/MCP-SERVER.md diff --git a/docs/i18n/sw/docs/FEATURES.md b/docs/i18n/sw/docs/guides/FEATURES.md similarity index 100% rename from docs/i18n/sw/docs/FEATURES.md rename to docs/i18n/sw/docs/guides/FEATURES.md diff --git a/docs/i18n/sw/docs/I18N.md b/docs/i18n/sw/docs/guides/I18N.md similarity index 99% rename from docs/i18n/sw/docs/I18N.md rename to docs/i18n/sw/docs/guides/I18N.md index 74b495c242..ec2ad43df7 100644 --- a/docs/i18n/sw/docs/I18N.md +++ b/docs/i18n/sw/docs/guides/I18N.md @@ -420,7 +420,7 @@ The generator originally used `code: "in"` (deprecated Google Translate code) fo ### `docs/i18n/README.md` Is Auto-Generated -The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/I18N.md` (this file) for hand-written documentation that should persist. +The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/guides/I18N.md` (this file) for hand-written documentation that should persist. ### External Untranslatable Keys List diff --git a/docs/i18n/sw/docs/TROUBLESHOOTING.md b/docs/i18n/sw/docs/guides/TROUBLESHOOTING.md similarity index 98% rename from docs/i18n/sw/docs/TROUBLESHOOTING.md rename to docs/i18n/sw/docs/guides/TROUBLESHOOTING.md index d627ca0715..2e501b3b0d 100644 --- a/docs/i18n/sw/docs/TROUBLESHOOTING.md +++ b/docs/i18n/sw/docs/guides/TROUBLESHOOTING.md @@ -335,7 +335,7 @@ You can ignore this section if you do not run RAG or agent pipelines behind Omni ## Still Stuck? - **GitHub Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) -- **Architecture**: See [`docs/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details -- **API Reference**: See [`docs/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints - **Health Dashboard**: Check **Dashboard → Health** for real-time system status - **Translator**: Use **Dashboard → Translator** to debug format issues diff --git a/docs/i18n/sw/docs/UNINSTALL.md b/docs/i18n/sw/docs/guides/UNINSTALL.md similarity index 100% rename from docs/i18n/sw/docs/UNINSTALL.md rename to docs/i18n/sw/docs/guides/UNINSTALL.md diff --git a/docs/i18n/sw/docs/USER_GUIDE.md b/docs/i18n/sw/docs/guides/USER_GUIDE.md similarity index 100% rename from docs/i18n/sw/docs/USER_GUIDE.md rename to docs/i18n/sw/docs/guides/USER_GUIDE.md diff --git a/docs/i18n/sw/docs/COVERAGE_PLAN.md b/docs/i18n/sw/docs/ops/COVERAGE_PLAN.md similarity index 100% rename from docs/i18n/sw/docs/COVERAGE_PLAN.md rename to docs/i18n/sw/docs/ops/COVERAGE_PLAN.md diff --git a/docs/i18n/sw/docs/FLY_IO_DEPLOYMENT_GUIDE.md b/docs/i18n/sw/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/sw/docs/FLY_IO_DEPLOYMENT_GUIDE.md rename to docs/i18n/sw/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/sw/docs/RELEASE_CHECKLIST.md b/docs/i18n/sw/docs/ops/RELEASE_CHECKLIST.md similarity index 94% rename from docs/i18n/sw/docs/RELEASE_CHECKLIST.md rename to docs/i18n/sw/docs/ops/RELEASE_CHECKLIST.md index 2c25414513..f2e36d0e84 100644 --- a/docs/i18n/sw/docs/RELEASE_CHECKLIST.md +++ b/docs/i18n/sw/docs/ops/RELEASE_CHECKLIST.md @@ -16,14 +16,14 @@ Use this checklist before tagging or publishing a new OmniRoute release. ## API Docs -1. Update `docs/openapi.yaml`: +1. Update `docs/reference/openapi.yaml`: - `info.version` must equal `package.json` version. 2. Validate endpoint examples if API contracts changed. ## Runtime Docs -1. Review `docs/ARCHITECTURE.md` for storage/runtime drift. -2. Review `docs/TROUBLESHOOTING.md` for env var and operational drift. +1. Review `docs/architecture/ARCHITECTURE.md` for storage/runtime drift. +2. Review `docs/guides/TROUBLESHOOTING.md` for env var and operational drift. 3. Verify the release/runtime Node.js version still satisfies the supported secure floor: - `>=20.20.2 <21` or `>=22.22.2 <23` - `npm run check:node-runtime` diff --git a/docs/i18n/sw/docs/VM_DEPLOYMENT_GUIDE.md b/docs/i18n/sw/docs/ops/VM_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/sw/docs/VM_DEPLOYMENT_GUIDE.md rename to docs/i18n/sw/docs/ops/VM_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/sw/docs/API_REFERENCE.md b/docs/i18n/sw/docs/reference/API_REFERENCE.md similarity index 100% rename from docs/i18n/sw/docs/API_REFERENCE.md rename to docs/i18n/sw/docs/reference/API_REFERENCE.md diff --git a/docs/i18n/sw/docs/CLI-TOOLS.md b/docs/i18n/sw/docs/reference/CLI-TOOLS.md similarity index 100% rename from docs/i18n/sw/docs/CLI-TOOLS.md rename to docs/i18n/sw/docs/reference/CLI-TOOLS.md diff --git a/docs/i18n/sw/docs/ENVIRONMENT.md b/docs/i18n/sw/docs/reference/ENVIRONMENT.md similarity index 100% rename from docs/i18n/sw/docs/ENVIRONMENT.md rename to docs/i18n/sw/docs/reference/ENVIRONMENT.md diff --git a/docs/i18n/sw/docs/AUTO-COMBO.md b/docs/i18n/sw/docs/routing/AUTO-COMBO.md similarity index 100% rename from docs/i18n/sw/docs/AUTO-COMBO.md rename to docs/i18n/sw/docs/routing/AUTO-COMBO.md diff --git a/docs/i18n/sw/llm.txt b/docs/i18n/sw/llm.txt index 5bc44125ea..0c8165bf65 100644 --- a/docs/i18n/sw/llm.txt +++ b/docs/i18n/sw/llm.txt @@ -357,11 +357,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### MCP Server (37 Tools) | Category | Tools | |------------|-------| -| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/MCP-SERVER.md` for full inventory) | +| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/frameworks/MCP-SERVER.md` for full inventory) | | Memory (3) | `memory_search`, `memory_add`, `memory_clear` | | Skills (4) | `skills_list`, `skills_enable`, `skills_execute`, `skills_executions` | -**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/MCP-SERVER.md`. +**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/frameworks/MCP-SERVER.md`. ### Provider Categories @@ -472,7 +472,7 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo 20. **Guardrails framework** in `src/lib/guardrails/` — hot-reloadable registry. Built-ins (priority-ordered): `vision-bridge` (5) → `pii-masker` (10) → `prompt-injection` (20). Fail-open model: exceptions never block traffic. Per-request opt-out via `x-omniroute-disabled-guardrails` header. -21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/AUTHZ_GUIDE.md`. +21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/architecture/AUTHZ_GUIDE.md`. 22. **Three resilience layers** are distinct (do not conflate them): - **Provider Circuit Breaker** (`src/shared/utils/circuitBreaker.ts`) — whole-provider scope. @@ -489,11 +489,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo - **MCP server expanded to 37 tools** (30 base + 3 memory + 4 skills) across ~13 scopes - **OAuth providers expanded to 14**: added Qwen, Kiro, Qoder, Gemini, Windsurf, GitLab Duo - **Coverage gate raised to 75/75/75/70** (was 60% across the board) — measured ~82% -- **Reasoning replay** (`docs/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams +- **Reasoning replay** (`docs/routing/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams - **Compliance + Evals + Webhooks** documentation introduced -- **Stealth guide** (`docs/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration -- **Tunnels guide** (`docs/TUNNELS_GUIDE.md`) — Cloudflare tunnel management -- **Electron guide** (`docs/ELECTRON_GUIDE.md`) — desktop app build + signing +- **Stealth guide** (`docs/security/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration +- **Tunnels guide** (`docs/ops/TUNNELS_GUIDE.md`) — Cloudflare tunnel management +- **Electron guide** (`docs/guides/ELECTRON_GUIDE.md`) — desktop app build + signing ## Links @@ -505,11 +505,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### Documentation Index -- **Architecture & Reference**: `docs/ARCHITECTURE.md`, `docs/CODEBASE_DOCUMENTATION.md`, `docs/REPOSITORY_MAP.md`, `docs/API_REFERENCE.md`, `docs/PROVIDER_REFERENCE.md`, `docs/openapi.yaml` -- **Operator guides**: `docs/USER_GUIDE.md`, `docs/CLI-TOOLS.md`, `docs/TROUBLESHOOTING.md`, `docs/COVERAGE_PLAN.md` -- **Protocols**: `docs/MCP-SERVER.md`, `docs/A2A-SERVER.md`, `docs/AGENT_PROTOCOLS_GUIDE.md`, `docs/CLOUD_AGENT.md` -- **Routing & resilience**: `docs/AUTO-COMBO.md`, `docs/RESILIENCE_GUIDE.md` -- **Security**: `docs/AUTHZ_GUIDE.md`, `docs/GUARDRAILS.md`, `docs/COMPLIANCE.md`, `docs/STEALTH_GUIDE.md` -- **Extensibility**: `docs/SKILLS.md`, `docs/MEMORY.md`, `docs/EVALS.md`, `docs/WEBHOOKS.md`, `docs/REASONING_REPLAY.md` -- **Platform**: `docs/ELECTRON_GUIDE.md`, `docs/TUNNELS_GUIDE.md` +- **Architecture & Reference**: `docs/architecture/ARCHITECTURE.md`, `docs/architecture/CODEBASE_DOCUMENTATION.md`, `docs/architecture/REPOSITORY_MAP.md`, `docs/reference/API_REFERENCE.md`, `docs/reference/PROVIDER_REFERENCE.md`, `docs/reference/openapi.yaml` +- **Operator guides**: `docs/guides/USER_GUIDE.md`, `docs/reference/CLI-TOOLS.md`, `docs/guides/TROUBLESHOOTING.md`, `docs/ops/COVERAGE_PLAN.md` +- **Protocols**: `docs/frameworks/MCP-SERVER.md`, `docs/frameworks/A2A-SERVER.md`, `docs/frameworks/AGENT_PROTOCOLS_GUIDE.md`, `docs/frameworks/CLOUD_AGENT.md` +- **Routing & resilience**: `docs/routing/AUTO-COMBO.md`, `docs/architecture/RESILIENCE_GUIDE.md` +- **Security**: `docs/architecture/AUTHZ_GUIDE.md`, `docs/security/GUARDRAILS.md`, `docs/security/COMPLIANCE.md`, `docs/security/STEALTH_GUIDE.md` +- **Extensibility**: `docs/frameworks/SKILLS.md`, `docs/frameworks/MEMORY.md`, `docs/frameworks/EVALS.md`, `docs/frameworks/WEBHOOKS.md`, `docs/routing/REASONING_REPLAY.md` +- **Platform**: `docs/guides/ELECTRON_GUIDE.md`, `docs/ops/TUNNELS_GUIDE.md` - **AI agents**: `CLAUDE.md`, `AGENTS.md`, `GEMINI.md` diff --git a/docs/i18n/ta/CHANGELOG.md b/docs/i18n/ta/CHANGELOG.md index 51ced7a4b1..9d804825ce 100644 --- a/docs/i18n/ta/CHANGELOG.md +++ b/docs/i18n/ta/CHANGELOG.md @@ -1310,7 +1310,7 @@ We identified that **155 community PRs** across the entire project history (from - **33 New API Key Providers:** Massive provider expansion adding DeepInfra, Vercel AI Gateway, Lambda AI, SambaNova, nScale, OVHcloud AI, Baseten, PublicAI, Moonshot AI, Meta Llama API, v0 (Vercel), Morph, Featherless AI, FriendliAI, LlamaGate, Galadriel, Weights & Biases Inference, Volcengine, AI21 Labs, Venice.ai, Codestral, Upstage, Maritalk, Xiaomi MiMo, Inference.net, NanoGPT, Predibase, Bytez, Heroku AI, Databricks, Snowflake Cortex, and GigaChat (Sber). OmniRoute now supports **100+ providers** (4 Free + 8 OAuth + 91 API Key + Custom compatible) - **Global Email Privacy Toggle:** Added a persistent eye-icon toggle button across all dashboard pages (Providers, Usage Limits, Playground) that reveals or hides masked email addresses. Toggle state is stored in localStorage and synced globally via Zustand store - **Documentation Refresh:** Updated README, ARCHITECTURE, FEATURES, AGENTS.md, and API_REFERENCE for v3.6.2 with accurate provider counts (100+), new executor list, and system API documentation -- **Uninstall Guide:** Created comprehensive `docs/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) +- **Uninstall Guide:** Created comprehensive `docs/guides/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) ### 🐛 Bug Fixes diff --git a/docs/i18n/ta/CONTRIBUTING.md b/docs/i18n/ta/CONTRIBUTING.md index cd3facbcae..188e0d7f56 100644 --- a/docs/i18n/ta/CONTRIBUTING.md +++ b/docs/i18n/ta/CONTRIBUTING.md @@ -153,7 +153,7 @@ Coverage notes: - If a PR changes production code in `src/`, `open-sse/`, `electron/`, or `bin/`, it must add or update automated tests in the same PR - `npm run coverage:report` prints the detailed file-by-file report from the latest coverage run - `npm run test:coverage:legacy` preserves the older metric for historical comparison -- See `docs/COVERAGE_PLAN.md` for the phased coverage improvement roadmap +- See `docs/ops/COVERAGE_PLAN.md` for the phased coverage improvement roadmap ### Pull Request Requirements @@ -305,7 +305,7 @@ Releases are managed via the `/generate-release` workflow. When a new GitHub Rel ## Getting Help -- **Architecture**: See [`docs/ARCHITECTURE.md`](docs/ARCHITECTURE.md) -- **API Reference**: See [`docs/API_REFERENCE.md`](docs/API_REFERENCE.md) +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](docs/architecture/ARCHITECTURE.md) +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](docs/reference/API_REFERENCE.md) - **Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) - **ADRs**: See `docs/adr/` for architectural decision records diff --git a/docs/i18n/ta/README.md b/docs/i18n/ta/README.md index 0be49d8e50..b1ff3cc743 100644 --- a/docs/i18n/ta/README.md +++ b/docs/i18n/ta/README.md @@ -2267,25 +2267,25 @@ Se não quiser criar credenciais próprias agora, ainda é possível usar o flux ## Documentación -| Document | Description | -| -------------------------------------------------------- | --------------------------------------------------- | -| [User Guide](docs/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | -| [API Reference](docs/API_REFERENCE.md) | All endpoints with examples | -| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | -| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | -| [Auto-Combo Engine](docs/auto-combo.md) | 6-factor scoring, mode packs, self-healing | -| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | -| [Troubleshooting](docs/TROUBLESHOOTING.md) | Common problems and solutions | -| [Architecture](docs/ARCHITECTURE.md) | System architecture and internals | -| [Codebase Documentation](docs/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | -| [Uninstall Guide](docs/UNINSTALL.md) | Clean removal for all install methods | -| [Environment Config](docs/ENVIRONMENT.md) | Complete `.env` variables and references | -| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | -| [OpenAPI Spec](docs/openapi.yaml) | OpenAPI 3.0 specification | -| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | -| [VM Deployment](docs/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | -| [Features Gallery](docs/FEATURES.md) | Visual dashboard tour with screenshots | -| [Release Checklist](docs/RELEASE_CHECKLIST.md) | Pre-release validation steps | +| Document | Description | +| --------------------------------------------------------------------- | --------------------------------------------------- | +| [User Guide](docs/guides/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | +| [API Reference](docs/reference/API_REFERENCE.md) | All endpoints with examples | +| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | +| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | +| [Auto-Combo Engine](docs/auto-combo.md) | 6-factor scoring, mode packs, self-healing | +| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | +| [Troubleshooting](docs/guides/TROUBLESHOOTING.md) | Common problems and solutions | +| [Architecture](docs/architecture/ARCHITECTURE.md) | System architecture and internals | +| [Codebase Documentation](docs/architecture/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | +| [Uninstall Guide](docs/guides/UNINSTALL.md) | Clean removal for all install methods | +| [Environment Config](docs/reference/ENVIRONMENT.md) | Complete `.env` variables and references | +| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | +| [OpenAPI Spec](docs/reference/openapi.yaml) | OpenAPI 3.0 specification | +| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | +| [VM Deployment](docs/ops/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | +| [Features Gallery](docs/guides/FEATURES.md) | Visual dashboard tour with screenshots | +| [Release Checklist](docs/ops/RELEASE_CHECKLIST.md) | Pre-release validation steps | --- diff --git a/docs/i18n/ta/docs/ARCHITECTURE.md b/docs/i18n/ta/docs/architecture/ARCHITECTURE.md similarity index 100% rename from docs/i18n/ta/docs/ARCHITECTURE.md rename to docs/i18n/ta/docs/architecture/ARCHITECTURE.md diff --git a/docs/i18n/ta/docs/CODEBASE_DOCUMENTATION.md b/docs/i18n/ta/docs/architecture/CODEBASE_DOCUMENTATION.md similarity index 100% rename from docs/i18n/ta/docs/CODEBASE_DOCUMENTATION.md rename to docs/i18n/ta/docs/architecture/CODEBASE_DOCUMENTATION.md diff --git a/docs/i18n/ta/docs/A2A-SERVER.md b/docs/i18n/ta/docs/frameworks/A2A-SERVER.md similarity index 100% rename from docs/i18n/ta/docs/A2A-SERVER.md rename to docs/i18n/ta/docs/frameworks/A2A-SERVER.md diff --git a/docs/i18n/ta/docs/MCP-SERVER.md b/docs/i18n/ta/docs/frameworks/MCP-SERVER.md similarity index 100% rename from docs/i18n/ta/docs/MCP-SERVER.md rename to docs/i18n/ta/docs/frameworks/MCP-SERVER.md diff --git a/docs/i18n/ta/docs/FEATURES.md b/docs/i18n/ta/docs/guides/FEATURES.md similarity index 100% rename from docs/i18n/ta/docs/FEATURES.md rename to docs/i18n/ta/docs/guides/FEATURES.md diff --git a/docs/i18n/ta/docs/I18N.md b/docs/i18n/ta/docs/guides/I18N.md similarity index 99% rename from docs/i18n/ta/docs/I18N.md rename to docs/i18n/ta/docs/guides/I18N.md index 13d2f896c0..679e0ae54e 100644 --- a/docs/i18n/ta/docs/I18N.md +++ b/docs/i18n/ta/docs/guides/I18N.md @@ -420,7 +420,7 @@ The generator originally used `code: "in"` (deprecated Google Translate code) fo ### `docs/i18n/README.md` Is Auto-Generated -The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/I18N.md` (this file) for hand-written documentation that should persist. +The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/guides/I18N.md` (this file) for hand-written documentation that should persist. ### External Untranslatable Keys List diff --git a/docs/i18n/ta/docs/TROUBLESHOOTING.md b/docs/i18n/ta/docs/guides/TROUBLESHOOTING.md similarity index 98% rename from docs/i18n/ta/docs/TROUBLESHOOTING.md rename to docs/i18n/ta/docs/guides/TROUBLESHOOTING.md index cd6d0db066..9ee7d18489 100644 --- a/docs/i18n/ta/docs/TROUBLESHOOTING.md +++ b/docs/i18n/ta/docs/guides/TROUBLESHOOTING.md @@ -335,7 +335,7 @@ You can ignore this section if you do not run RAG or agent pipelines behind Omni ## Still Stuck? - **GitHub Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) -- **Architecture**: See [`docs/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details -- **API Reference**: See [`docs/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints - **Health Dashboard**: Check **Dashboard → Health** for real-time system status - **Translator**: Use **Dashboard → Translator** to debug format issues diff --git a/docs/i18n/ta/docs/UNINSTALL.md b/docs/i18n/ta/docs/guides/UNINSTALL.md similarity index 100% rename from docs/i18n/ta/docs/UNINSTALL.md rename to docs/i18n/ta/docs/guides/UNINSTALL.md diff --git a/docs/i18n/ta/docs/USER_GUIDE.md b/docs/i18n/ta/docs/guides/USER_GUIDE.md similarity index 100% rename from docs/i18n/ta/docs/USER_GUIDE.md rename to docs/i18n/ta/docs/guides/USER_GUIDE.md diff --git a/docs/i18n/ta/docs/COVERAGE_PLAN.md b/docs/i18n/ta/docs/ops/COVERAGE_PLAN.md similarity index 100% rename from docs/i18n/ta/docs/COVERAGE_PLAN.md rename to docs/i18n/ta/docs/ops/COVERAGE_PLAN.md diff --git a/docs/i18n/ta/docs/FLY_IO_DEPLOYMENT_GUIDE.md b/docs/i18n/ta/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/ta/docs/FLY_IO_DEPLOYMENT_GUIDE.md rename to docs/i18n/ta/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/ta/docs/RELEASE_CHECKLIST.md b/docs/i18n/ta/docs/ops/RELEASE_CHECKLIST.md similarity index 94% rename from docs/i18n/ta/docs/RELEASE_CHECKLIST.md rename to docs/i18n/ta/docs/ops/RELEASE_CHECKLIST.md index a275cb136a..0e679b7a4b 100644 --- a/docs/i18n/ta/docs/RELEASE_CHECKLIST.md +++ b/docs/i18n/ta/docs/ops/RELEASE_CHECKLIST.md @@ -16,14 +16,14 @@ Use this checklist before tagging or publishing a new OmniRoute release. ## API Docs -1. Update `docs/openapi.yaml`: +1. Update `docs/reference/openapi.yaml`: - `info.version` must equal `package.json` version. 2. Validate endpoint examples if API contracts changed. ## Runtime Docs -1. Review `docs/ARCHITECTURE.md` for storage/runtime drift. -2. Review `docs/TROUBLESHOOTING.md` for env var and operational drift. +1. Review `docs/architecture/ARCHITECTURE.md` for storage/runtime drift. +2. Review `docs/guides/TROUBLESHOOTING.md` for env var and operational drift. 3. Verify the release/runtime Node.js version still satisfies the supported secure floor: - `>=20.20.2 <21` or `>=22.22.2 <23` - `npm run check:node-runtime` diff --git a/docs/i18n/ta/docs/VM_DEPLOYMENT_GUIDE.md b/docs/i18n/ta/docs/ops/VM_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/ta/docs/VM_DEPLOYMENT_GUIDE.md rename to docs/i18n/ta/docs/ops/VM_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/ta/docs/API_REFERENCE.md b/docs/i18n/ta/docs/reference/API_REFERENCE.md similarity index 100% rename from docs/i18n/ta/docs/API_REFERENCE.md rename to docs/i18n/ta/docs/reference/API_REFERENCE.md diff --git a/docs/i18n/ta/docs/CLI-TOOLS.md b/docs/i18n/ta/docs/reference/CLI-TOOLS.md similarity index 100% rename from docs/i18n/ta/docs/CLI-TOOLS.md rename to docs/i18n/ta/docs/reference/CLI-TOOLS.md diff --git a/docs/i18n/ta/docs/ENVIRONMENT.md b/docs/i18n/ta/docs/reference/ENVIRONMENT.md similarity index 100% rename from docs/i18n/ta/docs/ENVIRONMENT.md rename to docs/i18n/ta/docs/reference/ENVIRONMENT.md diff --git a/docs/i18n/ta/docs/AUTO-COMBO.md b/docs/i18n/ta/docs/routing/AUTO-COMBO.md similarity index 100% rename from docs/i18n/ta/docs/AUTO-COMBO.md rename to docs/i18n/ta/docs/routing/AUTO-COMBO.md diff --git a/docs/i18n/ta/llm.txt b/docs/i18n/ta/llm.txt index a6c818cf92..62f0392dfc 100644 --- a/docs/i18n/ta/llm.txt +++ b/docs/i18n/ta/llm.txt @@ -357,11 +357,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### MCP Server (37 Tools) | Category | Tools | |------------|-------| -| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/MCP-SERVER.md` for full inventory) | +| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/frameworks/MCP-SERVER.md` for full inventory) | | Memory (3) | `memory_search`, `memory_add`, `memory_clear` | | Skills (4) | `skills_list`, `skills_enable`, `skills_execute`, `skills_executions` | -**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/MCP-SERVER.md`. +**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/frameworks/MCP-SERVER.md`. ### Provider Categories @@ -472,7 +472,7 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo 20. **Guardrails framework** in `src/lib/guardrails/` — hot-reloadable registry. Built-ins (priority-ordered): `vision-bridge` (5) → `pii-masker` (10) → `prompt-injection` (20). Fail-open model: exceptions never block traffic. Per-request opt-out via `x-omniroute-disabled-guardrails` header. -21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/AUTHZ_GUIDE.md`. +21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/architecture/AUTHZ_GUIDE.md`. 22. **Three resilience layers** are distinct (do not conflate them): - **Provider Circuit Breaker** (`src/shared/utils/circuitBreaker.ts`) — whole-provider scope. @@ -489,11 +489,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo - **MCP server expanded to 37 tools** (30 base + 3 memory + 4 skills) across ~13 scopes - **OAuth providers expanded to 14**: added Qwen, Kiro, Qoder, Gemini, Windsurf, GitLab Duo - **Coverage gate raised to 75/75/75/70** (was 60% across the board) — measured ~82% -- **Reasoning replay** (`docs/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams +- **Reasoning replay** (`docs/routing/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams - **Compliance + Evals + Webhooks** documentation introduced -- **Stealth guide** (`docs/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration -- **Tunnels guide** (`docs/TUNNELS_GUIDE.md`) — Cloudflare tunnel management -- **Electron guide** (`docs/ELECTRON_GUIDE.md`) — desktop app build + signing +- **Stealth guide** (`docs/security/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration +- **Tunnels guide** (`docs/ops/TUNNELS_GUIDE.md`) — Cloudflare tunnel management +- **Electron guide** (`docs/guides/ELECTRON_GUIDE.md`) — desktop app build + signing ## Links @@ -505,11 +505,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### Documentation Index -- **Architecture & Reference**: `docs/ARCHITECTURE.md`, `docs/CODEBASE_DOCUMENTATION.md`, `docs/REPOSITORY_MAP.md`, `docs/API_REFERENCE.md`, `docs/PROVIDER_REFERENCE.md`, `docs/openapi.yaml` -- **Operator guides**: `docs/USER_GUIDE.md`, `docs/CLI-TOOLS.md`, `docs/TROUBLESHOOTING.md`, `docs/COVERAGE_PLAN.md` -- **Protocols**: `docs/MCP-SERVER.md`, `docs/A2A-SERVER.md`, `docs/AGENT_PROTOCOLS_GUIDE.md`, `docs/CLOUD_AGENT.md` -- **Routing & resilience**: `docs/AUTO-COMBO.md`, `docs/RESILIENCE_GUIDE.md` -- **Security**: `docs/AUTHZ_GUIDE.md`, `docs/GUARDRAILS.md`, `docs/COMPLIANCE.md`, `docs/STEALTH_GUIDE.md` -- **Extensibility**: `docs/SKILLS.md`, `docs/MEMORY.md`, `docs/EVALS.md`, `docs/WEBHOOKS.md`, `docs/REASONING_REPLAY.md` -- **Platform**: `docs/ELECTRON_GUIDE.md`, `docs/TUNNELS_GUIDE.md` +- **Architecture & Reference**: `docs/architecture/ARCHITECTURE.md`, `docs/architecture/CODEBASE_DOCUMENTATION.md`, `docs/architecture/REPOSITORY_MAP.md`, `docs/reference/API_REFERENCE.md`, `docs/reference/PROVIDER_REFERENCE.md`, `docs/reference/openapi.yaml` +- **Operator guides**: `docs/guides/USER_GUIDE.md`, `docs/reference/CLI-TOOLS.md`, `docs/guides/TROUBLESHOOTING.md`, `docs/ops/COVERAGE_PLAN.md` +- **Protocols**: `docs/frameworks/MCP-SERVER.md`, `docs/frameworks/A2A-SERVER.md`, `docs/frameworks/AGENT_PROTOCOLS_GUIDE.md`, `docs/frameworks/CLOUD_AGENT.md` +- **Routing & resilience**: `docs/routing/AUTO-COMBO.md`, `docs/architecture/RESILIENCE_GUIDE.md` +- **Security**: `docs/architecture/AUTHZ_GUIDE.md`, `docs/security/GUARDRAILS.md`, `docs/security/COMPLIANCE.md`, `docs/security/STEALTH_GUIDE.md` +- **Extensibility**: `docs/frameworks/SKILLS.md`, `docs/frameworks/MEMORY.md`, `docs/frameworks/EVALS.md`, `docs/frameworks/WEBHOOKS.md`, `docs/routing/REASONING_REPLAY.md` +- **Platform**: `docs/guides/ELECTRON_GUIDE.md`, `docs/ops/TUNNELS_GUIDE.md` - **AI agents**: `CLAUDE.md`, `AGENTS.md`, `GEMINI.md` diff --git a/docs/i18n/te/CHANGELOG.md b/docs/i18n/te/CHANGELOG.md index b76ad099d0..223be5d4ca 100644 --- a/docs/i18n/te/CHANGELOG.md +++ b/docs/i18n/te/CHANGELOG.md @@ -1310,7 +1310,7 @@ We identified that **155 community PRs** across the entire project history (from - **33 New API Key Providers:** Massive provider expansion adding DeepInfra, Vercel AI Gateway, Lambda AI, SambaNova, nScale, OVHcloud AI, Baseten, PublicAI, Moonshot AI, Meta Llama API, v0 (Vercel), Morph, Featherless AI, FriendliAI, LlamaGate, Galadriel, Weights & Biases Inference, Volcengine, AI21 Labs, Venice.ai, Codestral, Upstage, Maritalk, Xiaomi MiMo, Inference.net, NanoGPT, Predibase, Bytez, Heroku AI, Databricks, Snowflake Cortex, and GigaChat (Sber). OmniRoute now supports **100+ providers** (4 Free + 8 OAuth + 91 API Key + Custom compatible) - **Global Email Privacy Toggle:** Added a persistent eye-icon toggle button across all dashboard pages (Providers, Usage Limits, Playground) that reveals or hides masked email addresses. Toggle state is stored in localStorage and synced globally via Zustand store - **Documentation Refresh:** Updated README, ARCHITECTURE, FEATURES, AGENTS.md, and API_REFERENCE for v3.6.2 with accurate provider counts (100+), new executor list, and system API documentation -- **Uninstall Guide:** Created comprehensive `docs/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) +- **Uninstall Guide:** Created comprehensive `docs/guides/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) ### 🐛 Bug Fixes diff --git a/docs/i18n/te/CONTRIBUTING.md b/docs/i18n/te/CONTRIBUTING.md index 9898b8ff2e..a543a9422a 100644 --- a/docs/i18n/te/CONTRIBUTING.md +++ b/docs/i18n/te/CONTRIBUTING.md @@ -153,7 +153,7 @@ Coverage notes: - If a PR changes production code in `src/`, `open-sse/`, `electron/`, or `bin/`, it must add or update automated tests in the same PR - `npm run coverage:report` prints the detailed file-by-file report from the latest coverage run - `npm run test:coverage:legacy` preserves the older metric for historical comparison -- See `docs/COVERAGE_PLAN.md` for the phased coverage improvement roadmap +- See `docs/ops/COVERAGE_PLAN.md` for the phased coverage improvement roadmap ### Pull Request Requirements @@ -305,7 +305,7 @@ Releases are managed via the `/generate-release` workflow. When a new GitHub Rel ## Getting Help -- **Architecture**: See [`docs/ARCHITECTURE.md`](docs/ARCHITECTURE.md) -- **API Reference**: See [`docs/API_REFERENCE.md`](docs/API_REFERENCE.md) +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](docs/architecture/ARCHITECTURE.md) +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](docs/reference/API_REFERENCE.md) - **Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) - **ADRs**: See `docs/adr/` for architectural decision records diff --git a/docs/i18n/te/README.md b/docs/i18n/te/README.md index fa7c3c41ac..a4df895043 100644 --- a/docs/i18n/te/README.md +++ b/docs/i18n/te/README.md @@ -2267,25 +2267,25 @@ Se não quiser criar credenciais próprias agora, ainda é possível usar o flux ## Documentación -| Document | Description | -| -------------------------------------------------------- | --------------------------------------------------- | -| [User Guide](docs/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | -| [API Reference](docs/API_REFERENCE.md) | All endpoints with examples | -| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | -| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | -| [Auto-Combo Engine](docs/auto-combo.md) | 6-factor scoring, mode packs, self-healing | -| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | -| [Troubleshooting](docs/TROUBLESHOOTING.md) | Common problems and solutions | -| [Architecture](docs/ARCHITECTURE.md) | System architecture and internals | -| [Codebase Documentation](docs/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | -| [Uninstall Guide](docs/UNINSTALL.md) | Clean removal for all install methods | -| [Environment Config](docs/ENVIRONMENT.md) | Complete `.env` variables and references | -| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | -| [OpenAPI Spec](docs/openapi.yaml) | OpenAPI 3.0 specification | -| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | -| [VM Deployment](docs/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | -| [Features Gallery](docs/FEATURES.md) | Visual dashboard tour with screenshots | -| [Release Checklist](docs/RELEASE_CHECKLIST.md) | Pre-release validation steps | +| Document | Description | +| --------------------------------------------------------------------- | --------------------------------------------------- | +| [User Guide](docs/guides/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | +| [API Reference](docs/reference/API_REFERENCE.md) | All endpoints with examples | +| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | +| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | +| [Auto-Combo Engine](docs/auto-combo.md) | 6-factor scoring, mode packs, self-healing | +| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | +| [Troubleshooting](docs/guides/TROUBLESHOOTING.md) | Common problems and solutions | +| [Architecture](docs/architecture/ARCHITECTURE.md) | System architecture and internals | +| [Codebase Documentation](docs/architecture/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | +| [Uninstall Guide](docs/guides/UNINSTALL.md) | Clean removal for all install methods | +| [Environment Config](docs/reference/ENVIRONMENT.md) | Complete `.env` variables and references | +| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | +| [OpenAPI Spec](docs/reference/openapi.yaml) | OpenAPI 3.0 specification | +| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | +| [VM Deployment](docs/ops/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | +| [Features Gallery](docs/guides/FEATURES.md) | Visual dashboard tour with screenshots | +| [Release Checklist](docs/ops/RELEASE_CHECKLIST.md) | Pre-release validation steps | --- diff --git a/docs/i18n/te/docs/ARCHITECTURE.md b/docs/i18n/te/docs/architecture/ARCHITECTURE.md similarity index 100% rename from docs/i18n/te/docs/ARCHITECTURE.md rename to docs/i18n/te/docs/architecture/ARCHITECTURE.md diff --git a/docs/i18n/te/docs/CODEBASE_DOCUMENTATION.md b/docs/i18n/te/docs/architecture/CODEBASE_DOCUMENTATION.md similarity index 100% rename from docs/i18n/te/docs/CODEBASE_DOCUMENTATION.md rename to docs/i18n/te/docs/architecture/CODEBASE_DOCUMENTATION.md diff --git a/docs/i18n/te/docs/A2A-SERVER.md b/docs/i18n/te/docs/frameworks/A2A-SERVER.md similarity index 100% rename from docs/i18n/te/docs/A2A-SERVER.md rename to docs/i18n/te/docs/frameworks/A2A-SERVER.md diff --git a/docs/i18n/te/docs/MCP-SERVER.md b/docs/i18n/te/docs/frameworks/MCP-SERVER.md similarity index 100% rename from docs/i18n/te/docs/MCP-SERVER.md rename to docs/i18n/te/docs/frameworks/MCP-SERVER.md diff --git a/docs/i18n/te/docs/FEATURES.md b/docs/i18n/te/docs/guides/FEATURES.md similarity index 100% rename from docs/i18n/te/docs/FEATURES.md rename to docs/i18n/te/docs/guides/FEATURES.md diff --git a/docs/i18n/te/docs/I18N.md b/docs/i18n/te/docs/guides/I18N.md similarity index 99% rename from docs/i18n/te/docs/I18N.md rename to docs/i18n/te/docs/guides/I18N.md index 336c3be722..41a3fde528 100644 --- a/docs/i18n/te/docs/I18N.md +++ b/docs/i18n/te/docs/guides/I18N.md @@ -420,7 +420,7 @@ The generator originally used `code: "in"` (deprecated Google Translate code) fo ### `docs/i18n/README.md` Is Auto-Generated -The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/I18N.md` (this file) for hand-written documentation that should persist. +The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/guides/I18N.md` (this file) for hand-written documentation that should persist. ### External Untranslatable Keys List diff --git a/docs/i18n/te/docs/TROUBLESHOOTING.md b/docs/i18n/te/docs/guides/TROUBLESHOOTING.md similarity index 98% rename from docs/i18n/te/docs/TROUBLESHOOTING.md rename to docs/i18n/te/docs/guides/TROUBLESHOOTING.md index 5a13f106b3..b2421aaa15 100644 --- a/docs/i18n/te/docs/TROUBLESHOOTING.md +++ b/docs/i18n/te/docs/guides/TROUBLESHOOTING.md @@ -335,7 +335,7 @@ You can ignore this section if you do not run RAG or agent pipelines behind Omni ## Still Stuck? - **GitHub Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) -- **Architecture**: See [`docs/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details -- **API Reference**: See [`docs/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints - **Health Dashboard**: Check **Dashboard → Health** for real-time system status - **Translator**: Use **Dashboard → Translator** to debug format issues diff --git a/docs/i18n/te/docs/UNINSTALL.md b/docs/i18n/te/docs/guides/UNINSTALL.md similarity index 100% rename from docs/i18n/te/docs/UNINSTALL.md rename to docs/i18n/te/docs/guides/UNINSTALL.md diff --git a/docs/i18n/te/docs/USER_GUIDE.md b/docs/i18n/te/docs/guides/USER_GUIDE.md similarity index 100% rename from docs/i18n/te/docs/USER_GUIDE.md rename to docs/i18n/te/docs/guides/USER_GUIDE.md diff --git a/docs/i18n/te/docs/COVERAGE_PLAN.md b/docs/i18n/te/docs/ops/COVERAGE_PLAN.md similarity index 100% rename from docs/i18n/te/docs/COVERAGE_PLAN.md rename to docs/i18n/te/docs/ops/COVERAGE_PLAN.md diff --git a/docs/i18n/te/docs/FLY_IO_DEPLOYMENT_GUIDE.md b/docs/i18n/te/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/te/docs/FLY_IO_DEPLOYMENT_GUIDE.md rename to docs/i18n/te/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/te/docs/RELEASE_CHECKLIST.md b/docs/i18n/te/docs/ops/RELEASE_CHECKLIST.md similarity index 94% rename from docs/i18n/te/docs/RELEASE_CHECKLIST.md rename to docs/i18n/te/docs/ops/RELEASE_CHECKLIST.md index f3e0f7d363..172905ed12 100644 --- a/docs/i18n/te/docs/RELEASE_CHECKLIST.md +++ b/docs/i18n/te/docs/ops/RELEASE_CHECKLIST.md @@ -16,14 +16,14 @@ Use this checklist before tagging or publishing a new OmniRoute release. ## API Docs -1. Update `docs/openapi.yaml`: +1. Update `docs/reference/openapi.yaml`: - `info.version` must equal `package.json` version. 2. Validate endpoint examples if API contracts changed. ## Runtime Docs -1. Review `docs/ARCHITECTURE.md` for storage/runtime drift. -2. Review `docs/TROUBLESHOOTING.md` for env var and operational drift. +1. Review `docs/architecture/ARCHITECTURE.md` for storage/runtime drift. +2. Review `docs/guides/TROUBLESHOOTING.md` for env var and operational drift. 3. Verify the release/runtime Node.js version still satisfies the supported secure floor: - `>=20.20.2 <21` or `>=22.22.2 <23` - `npm run check:node-runtime` diff --git a/docs/i18n/te/docs/VM_DEPLOYMENT_GUIDE.md b/docs/i18n/te/docs/ops/VM_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/te/docs/VM_DEPLOYMENT_GUIDE.md rename to docs/i18n/te/docs/ops/VM_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/te/docs/API_REFERENCE.md b/docs/i18n/te/docs/reference/API_REFERENCE.md similarity index 100% rename from docs/i18n/te/docs/API_REFERENCE.md rename to docs/i18n/te/docs/reference/API_REFERENCE.md diff --git a/docs/i18n/te/docs/CLI-TOOLS.md b/docs/i18n/te/docs/reference/CLI-TOOLS.md similarity index 100% rename from docs/i18n/te/docs/CLI-TOOLS.md rename to docs/i18n/te/docs/reference/CLI-TOOLS.md diff --git a/docs/i18n/te/docs/ENVIRONMENT.md b/docs/i18n/te/docs/reference/ENVIRONMENT.md similarity index 100% rename from docs/i18n/te/docs/ENVIRONMENT.md rename to docs/i18n/te/docs/reference/ENVIRONMENT.md diff --git a/docs/i18n/te/docs/AUTO-COMBO.md b/docs/i18n/te/docs/routing/AUTO-COMBO.md similarity index 100% rename from docs/i18n/te/docs/AUTO-COMBO.md rename to docs/i18n/te/docs/routing/AUTO-COMBO.md diff --git a/docs/i18n/te/llm.txt b/docs/i18n/te/llm.txt index ed29612aad..90bfc5ed3f 100644 --- a/docs/i18n/te/llm.txt +++ b/docs/i18n/te/llm.txt @@ -357,11 +357,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### MCP Server (37 Tools) | Category | Tools | |------------|-------| -| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/MCP-SERVER.md` for full inventory) | +| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/frameworks/MCP-SERVER.md` for full inventory) | | Memory (3) | `memory_search`, `memory_add`, `memory_clear` | | Skills (4) | `skills_list`, `skills_enable`, `skills_execute`, `skills_executions` | -**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/MCP-SERVER.md`. +**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/frameworks/MCP-SERVER.md`. ### Provider Categories @@ -472,7 +472,7 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo 20. **Guardrails framework** in `src/lib/guardrails/` — hot-reloadable registry. Built-ins (priority-ordered): `vision-bridge` (5) → `pii-masker` (10) → `prompt-injection` (20). Fail-open model: exceptions never block traffic. Per-request opt-out via `x-omniroute-disabled-guardrails` header. -21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/AUTHZ_GUIDE.md`. +21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/architecture/AUTHZ_GUIDE.md`. 22. **Three resilience layers** are distinct (do not conflate them): - **Provider Circuit Breaker** (`src/shared/utils/circuitBreaker.ts`) — whole-provider scope. @@ -489,11 +489,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo - **MCP server expanded to 37 tools** (30 base + 3 memory + 4 skills) across ~13 scopes - **OAuth providers expanded to 14**: added Qwen, Kiro, Qoder, Gemini, Windsurf, GitLab Duo - **Coverage gate raised to 75/75/75/70** (was 60% across the board) — measured ~82% -- **Reasoning replay** (`docs/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams +- **Reasoning replay** (`docs/routing/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams - **Compliance + Evals + Webhooks** documentation introduced -- **Stealth guide** (`docs/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration -- **Tunnels guide** (`docs/TUNNELS_GUIDE.md`) — Cloudflare tunnel management -- **Electron guide** (`docs/ELECTRON_GUIDE.md`) — desktop app build + signing +- **Stealth guide** (`docs/security/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration +- **Tunnels guide** (`docs/ops/TUNNELS_GUIDE.md`) — Cloudflare tunnel management +- **Electron guide** (`docs/guides/ELECTRON_GUIDE.md`) — desktop app build + signing ## Links @@ -505,11 +505,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### Documentation Index -- **Architecture & Reference**: `docs/ARCHITECTURE.md`, `docs/CODEBASE_DOCUMENTATION.md`, `docs/REPOSITORY_MAP.md`, `docs/API_REFERENCE.md`, `docs/PROVIDER_REFERENCE.md`, `docs/openapi.yaml` -- **Operator guides**: `docs/USER_GUIDE.md`, `docs/CLI-TOOLS.md`, `docs/TROUBLESHOOTING.md`, `docs/COVERAGE_PLAN.md` -- **Protocols**: `docs/MCP-SERVER.md`, `docs/A2A-SERVER.md`, `docs/AGENT_PROTOCOLS_GUIDE.md`, `docs/CLOUD_AGENT.md` -- **Routing & resilience**: `docs/AUTO-COMBO.md`, `docs/RESILIENCE_GUIDE.md` -- **Security**: `docs/AUTHZ_GUIDE.md`, `docs/GUARDRAILS.md`, `docs/COMPLIANCE.md`, `docs/STEALTH_GUIDE.md` -- **Extensibility**: `docs/SKILLS.md`, `docs/MEMORY.md`, `docs/EVALS.md`, `docs/WEBHOOKS.md`, `docs/REASONING_REPLAY.md` -- **Platform**: `docs/ELECTRON_GUIDE.md`, `docs/TUNNELS_GUIDE.md` +- **Architecture & Reference**: `docs/architecture/ARCHITECTURE.md`, `docs/architecture/CODEBASE_DOCUMENTATION.md`, `docs/architecture/REPOSITORY_MAP.md`, `docs/reference/API_REFERENCE.md`, `docs/reference/PROVIDER_REFERENCE.md`, `docs/reference/openapi.yaml` +- **Operator guides**: `docs/guides/USER_GUIDE.md`, `docs/reference/CLI-TOOLS.md`, `docs/guides/TROUBLESHOOTING.md`, `docs/ops/COVERAGE_PLAN.md` +- **Protocols**: `docs/frameworks/MCP-SERVER.md`, `docs/frameworks/A2A-SERVER.md`, `docs/frameworks/AGENT_PROTOCOLS_GUIDE.md`, `docs/frameworks/CLOUD_AGENT.md` +- **Routing & resilience**: `docs/routing/AUTO-COMBO.md`, `docs/architecture/RESILIENCE_GUIDE.md` +- **Security**: `docs/architecture/AUTHZ_GUIDE.md`, `docs/security/GUARDRAILS.md`, `docs/security/COMPLIANCE.md`, `docs/security/STEALTH_GUIDE.md` +- **Extensibility**: `docs/frameworks/SKILLS.md`, `docs/frameworks/MEMORY.md`, `docs/frameworks/EVALS.md`, `docs/frameworks/WEBHOOKS.md`, `docs/routing/REASONING_REPLAY.md` +- **Platform**: `docs/guides/ELECTRON_GUIDE.md`, `docs/ops/TUNNELS_GUIDE.md` - **AI agents**: `CLAUDE.md`, `AGENTS.md`, `GEMINI.md` diff --git a/docs/i18n/th/CHANGELOG.md b/docs/i18n/th/CHANGELOG.md index e9006ce8cb..1c18e1a99f 100644 --- a/docs/i18n/th/CHANGELOG.md +++ b/docs/i18n/th/CHANGELOG.md @@ -1310,7 +1310,7 @@ We identified that **155 community PRs** across the entire project history (from - **33 New API Key Providers:** Massive provider expansion adding DeepInfra, Vercel AI Gateway, Lambda AI, SambaNova, nScale, OVHcloud AI, Baseten, PublicAI, Moonshot AI, Meta Llama API, v0 (Vercel), Morph, Featherless AI, FriendliAI, LlamaGate, Galadriel, Weights & Biases Inference, Volcengine, AI21 Labs, Venice.ai, Codestral, Upstage, Maritalk, Xiaomi MiMo, Inference.net, NanoGPT, Predibase, Bytez, Heroku AI, Databricks, Snowflake Cortex, and GigaChat (Sber). OmniRoute now supports **100+ providers** (4 Free + 8 OAuth + 91 API Key + Custom compatible) - **Global Email Privacy Toggle:** Added a persistent eye-icon toggle button across all dashboard pages (Providers, Usage Limits, Playground) that reveals or hides masked email addresses. Toggle state is stored in localStorage and synced globally via Zustand store - **Documentation Refresh:** Updated README, ARCHITECTURE, FEATURES, AGENTS.md, and API_REFERENCE for v3.6.2 with accurate provider counts (100+), new executor list, and system API documentation -- **Uninstall Guide:** Created comprehensive `docs/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) +- **Uninstall Guide:** Created comprehensive `docs/guides/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) ### 🐛 Bug Fixes diff --git a/docs/i18n/th/CONTRIBUTING.md b/docs/i18n/th/CONTRIBUTING.md index 81f73ea9c3..40d412c63f 100644 --- a/docs/i18n/th/CONTRIBUTING.md +++ b/docs/i18n/th/CONTRIBUTING.md @@ -153,7 +153,7 @@ Coverage notes: - If a PR changes production code in `src/`, `open-sse/`, `electron/`, or `bin/`, it must add or update automated tests in the same PR - `npm run coverage:report` prints the detailed file-by-file report from the latest coverage run - `npm run test:coverage:legacy` preserves the older metric for historical comparison -- See `docs/COVERAGE_PLAN.md` for the phased coverage improvement roadmap +- See `docs/ops/COVERAGE_PLAN.md` for the phased coverage improvement roadmap ### Pull Request Requirements @@ -305,7 +305,7 @@ Releases are managed via the `/generate-release` workflow. When a new GitHub Rel ## Getting Help -- **Architecture**: See [`docs/ARCHITECTURE.md`](docs/ARCHITECTURE.md) -- **API Reference**: See [`docs/API_REFERENCE.md`](docs/API_REFERENCE.md) +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](docs/architecture/ARCHITECTURE.md) +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](docs/reference/API_REFERENCE.md) - **Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) - **ADRs**: See `docs/adr/` for architectural decision records diff --git a/docs/i18n/th/README.md b/docs/i18n/th/README.md index 791cc41173..3310941bc0 100644 --- a/docs/i18n/th/README.md +++ b/docs/i18n/th/README.md @@ -2267,25 +2267,25 @@ Se não quiser criar credenciais próprias agora, ainda é possível usar o flux ## เอกสาร -| Document | Description | -| -------------------------------------------------------- | --------------------------------------------------- | -| [User Guide](docs/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | -| [API Reference](docs/API_REFERENCE.md) | All endpoints with examples | -| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | -| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | -| [Auto-Combo Engine](docs/AUTO-COMBO.md) | 6-factor scoring, mode packs, self-healing | -| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | -| [Troubleshooting](docs/TROUBLESHOOTING.md) | Common problems and solutions | -| [Architecture](docs/ARCHITECTURE.md) | System architecture and internals | -| [Codebase Documentation](docs/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | -| [Uninstall Guide](docs/UNINSTALL.md) | Clean removal for all install methods | -| [Environment Config](docs/ENVIRONMENT.md) | Complete `.env` variables and references | -| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | -| [OpenAPI Spec](docs/openapi.yaml) | OpenAPI 3.0 specification | -| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | -| [VM Deployment](docs/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | -| [Features Gallery](docs/FEATURES.md) | Visual dashboard tour with screenshots | -| [Release Checklist](docs/RELEASE_CHECKLIST.md) | Pre-release validation steps | +| Document | Description | +| --------------------------------------------------------------------- | --------------------------------------------------- | +| [User Guide](docs/guides/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | +| [API Reference](docs/reference/API_REFERENCE.md) | All endpoints with examples | +| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | +| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | +| [Auto-Combo Engine](docs/routing/AUTO-COMBO.md) | 6-factor scoring, mode packs, self-healing | +| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | +| [Troubleshooting](docs/guides/TROUBLESHOOTING.md) | Common problems and solutions | +| [Architecture](docs/architecture/ARCHITECTURE.md) | System architecture and internals | +| [Codebase Documentation](docs/architecture/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | +| [Uninstall Guide](docs/guides/UNINSTALL.md) | Clean removal for all install methods | +| [Environment Config](docs/reference/ENVIRONMENT.md) | Complete `.env` variables and references | +| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | +| [OpenAPI Spec](docs/reference/openapi.yaml) | OpenAPI 3.0 specification | +| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | +| [VM Deployment](docs/ops/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | +| [Features Gallery](docs/guides/FEATURES.md) | Visual dashboard tour with screenshots | +| [Release Checklist](docs/ops/RELEASE_CHECKLIST.md) | Pre-release validation steps | --- diff --git a/docs/i18n/th/docs/ARCHITECTURE.md b/docs/i18n/th/docs/architecture/ARCHITECTURE.md similarity index 100% rename from docs/i18n/th/docs/ARCHITECTURE.md rename to docs/i18n/th/docs/architecture/ARCHITECTURE.md diff --git a/docs/i18n/th/docs/CODEBASE_DOCUMENTATION.md b/docs/i18n/th/docs/architecture/CODEBASE_DOCUMENTATION.md similarity index 100% rename from docs/i18n/th/docs/CODEBASE_DOCUMENTATION.md rename to docs/i18n/th/docs/architecture/CODEBASE_DOCUMENTATION.md diff --git a/docs/i18n/th/docs/A2A-SERVER.md b/docs/i18n/th/docs/frameworks/A2A-SERVER.md similarity index 100% rename from docs/i18n/th/docs/A2A-SERVER.md rename to docs/i18n/th/docs/frameworks/A2A-SERVER.md diff --git a/docs/i18n/th/docs/MCP-SERVER.md b/docs/i18n/th/docs/frameworks/MCP-SERVER.md similarity index 100% rename from docs/i18n/th/docs/MCP-SERVER.md rename to docs/i18n/th/docs/frameworks/MCP-SERVER.md diff --git a/docs/i18n/th/docs/FEATURES.md b/docs/i18n/th/docs/guides/FEATURES.md similarity index 100% rename from docs/i18n/th/docs/FEATURES.md rename to docs/i18n/th/docs/guides/FEATURES.md diff --git a/docs/i18n/th/docs/I18N.md b/docs/i18n/th/docs/guides/I18N.md similarity index 99% rename from docs/i18n/th/docs/I18N.md rename to docs/i18n/th/docs/guides/I18N.md index 72b1081f7e..ffb13810a5 100644 --- a/docs/i18n/th/docs/I18N.md +++ b/docs/i18n/th/docs/guides/I18N.md @@ -420,7 +420,7 @@ The generator originally used `code: "in"` (deprecated Google Translate code) fo ### `docs/i18n/README.md` Is Auto-Generated -The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/I18N.md` (this file) for hand-written documentation that should persist. +The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/guides/I18N.md` (this file) for hand-written documentation that should persist. ### External Untranslatable Keys List diff --git a/docs/i18n/th/docs/TROUBLESHOOTING.md b/docs/i18n/th/docs/guides/TROUBLESHOOTING.md similarity index 98% rename from docs/i18n/th/docs/TROUBLESHOOTING.md rename to docs/i18n/th/docs/guides/TROUBLESHOOTING.md index e0343f007f..d26154aaad 100644 --- a/docs/i18n/th/docs/TROUBLESHOOTING.md +++ b/docs/i18n/th/docs/guides/TROUBLESHOOTING.md @@ -335,7 +335,7 @@ You can ignore this section if you do not run RAG or agent pipelines behind Omni ## Still Stuck? - **GitHub Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) -- **Architecture**: See [`docs/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details -- **API Reference**: See [`docs/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints - **Health Dashboard**: Check **Dashboard → Health** for real-time system status - **Translator**: Use **Dashboard → Translator** to debug format issues diff --git a/docs/i18n/th/docs/UNINSTALL.md b/docs/i18n/th/docs/guides/UNINSTALL.md similarity index 100% rename from docs/i18n/th/docs/UNINSTALL.md rename to docs/i18n/th/docs/guides/UNINSTALL.md diff --git a/docs/i18n/th/docs/USER_GUIDE.md b/docs/i18n/th/docs/guides/USER_GUIDE.md similarity index 100% rename from docs/i18n/th/docs/USER_GUIDE.md rename to docs/i18n/th/docs/guides/USER_GUIDE.md diff --git a/docs/i18n/th/docs/COVERAGE_PLAN.md b/docs/i18n/th/docs/ops/COVERAGE_PLAN.md similarity index 100% rename from docs/i18n/th/docs/COVERAGE_PLAN.md rename to docs/i18n/th/docs/ops/COVERAGE_PLAN.md diff --git a/docs/i18n/th/docs/FLY_IO_DEPLOYMENT_GUIDE.md b/docs/i18n/th/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/th/docs/FLY_IO_DEPLOYMENT_GUIDE.md rename to docs/i18n/th/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/th/docs/RELEASE_CHECKLIST.md b/docs/i18n/th/docs/ops/RELEASE_CHECKLIST.md similarity index 94% rename from docs/i18n/th/docs/RELEASE_CHECKLIST.md rename to docs/i18n/th/docs/ops/RELEASE_CHECKLIST.md index 9f31a4e1b7..7295220227 100644 --- a/docs/i18n/th/docs/RELEASE_CHECKLIST.md +++ b/docs/i18n/th/docs/ops/RELEASE_CHECKLIST.md @@ -16,14 +16,14 @@ Use this checklist before tagging or publishing a new OmniRoute release. ## API Docs -1. Update `docs/openapi.yaml`: +1. Update `docs/reference/openapi.yaml`: - `info.version` must equal `package.json` version. 2. Validate endpoint examples if API contracts changed. ## Runtime Docs -1. Review `docs/ARCHITECTURE.md` for storage/runtime drift. -2. Review `docs/TROUBLESHOOTING.md` for env var and operational drift. +1. Review `docs/architecture/ARCHITECTURE.md` for storage/runtime drift. +2. Review `docs/guides/TROUBLESHOOTING.md` for env var and operational drift. 3. Verify the release/runtime Node.js version still satisfies the supported secure floor: - `>=20.20.2 <21` or `>=22.22.2 <23` - `npm run check:node-runtime` diff --git a/docs/i18n/th/docs/VM_DEPLOYMENT_GUIDE.md b/docs/i18n/th/docs/ops/VM_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/th/docs/VM_DEPLOYMENT_GUIDE.md rename to docs/i18n/th/docs/ops/VM_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/th/docs/API_REFERENCE.md b/docs/i18n/th/docs/reference/API_REFERENCE.md similarity index 100% rename from docs/i18n/th/docs/API_REFERENCE.md rename to docs/i18n/th/docs/reference/API_REFERENCE.md diff --git a/docs/i18n/th/docs/CLI-TOOLS.md b/docs/i18n/th/docs/reference/CLI-TOOLS.md similarity index 100% rename from docs/i18n/th/docs/CLI-TOOLS.md rename to docs/i18n/th/docs/reference/CLI-TOOLS.md diff --git a/docs/i18n/th/docs/ENVIRONMENT.md b/docs/i18n/th/docs/reference/ENVIRONMENT.md similarity index 100% rename from docs/i18n/th/docs/ENVIRONMENT.md rename to docs/i18n/th/docs/reference/ENVIRONMENT.md diff --git a/docs/i18n/th/docs/AUTO-COMBO.md b/docs/i18n/th/docs/routing/AUTO-COMBO.md similarity index 100% rename from docs/i18n/th/docs/AUTO-COMBO.md rename to docs/i18n/th/docs/routing/AUTO-COMBO.md diff --git a/docs/i18n/th/llm.txt b/docs/i18n/th/llm.txt index 2c76b7e3aa..175e0a0551 100644 --- a/docs/i18n/th/llm.txt +++ b/docs/i18n/th/llm.txt @@ -357,11 +357,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### MCP Server (37 Tools) | Category | Tools | |------------|-------| -| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/MCP-SERVER.md` for full inventory) | +| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/frameworks/MCP-SERVER.md` for full inventory) | | Memory (3) | `memory_search`, `memory_add`, `memory_clear` | | Skills (4) | `skills_list`, `skills_enable`, `skills_execute`, `skills_executions` | -**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/MCP-SERVER.md`. +**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/frameworks/MCP-SERVER.md`. ### Provider Categories @@ -472,7 +472,7 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo 20. **Guardrails framework** in `src/lib/guardrails/` — hot-reloadable registry. Built-ins (priority-ordered): `vision-bridge` (5) → `pii-masker` (10) → `prompt-injection` (20). Fail-open model: exceptions never block traffic. Per-request opt-out via `x-omniroute-disabled-guardrails` header. -21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/AUTHZ_GUIDE.md`. +21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/architecture/AUTHZ_GUIDE.md`. 22. **Three resilience layers** are distinct (do not conflate them): - **Provider Circuit Breaker** (`src/shared/utils/circuitBreaker.ts`) — whole-provider scope. @@ -489,11 +489,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo - **MCP server expanded to 37 tools** (30 base + 3 memory + 4 skills) across ~13 scopes - **OAuth providers expanded to 14**: added Qwen, Kiro, Qoder, Gemini, Windsurf, GitLab Duo - **Coverage gate raised to 75/75/75/70** (was 60% across the board) — measured ~82% -- **Reasoning replay** (`docs/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams +- **Reasoning replay** (`docs/routing/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams - **Compliance + Evals + Webhooks** documentation introduced -- **Stealth guide** (`docs/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration -- **Tunnels guide** (`docs/TUNNELS_GUIDE.md`) — Cloudflare tunnel management -- **Electron guide** (`docs/ELECTRON_GUIDE.md`) — desktop app build + signing +- **Stealth guide** (`docs/security/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration +- **Tunnels guide** (`docs/ops/TUNNELS_GUIDE.md`) — Cloudflare tunnel management +- **Electron guide** (`docs/guides/ELECTRON_GUIDE.md`) — desktop app build + signing ## Links @@ -505,11 +505,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### Documentation Index -- **Architecture & Reference**: `docs/ARCHITECTURE.md`, `docs/CODEBASE_DOCUMENTATION.md`, `docs/REPOSITORY_MAP.md`, `docs/API_REFERENCE.md`, `docs/PROVIDER_REFERENCE.md`, `docs/openapi.yaml` -- **Operator guides**: `docs/USER_GUIDE.md`, `docs/CLI-TOOLS.md`, `docs/TROUBLESHOOTING.md`, `docs/COVERAGE_PLAN.md` -- **Protocols**: `docs/MCP-SERVER.md`, `docs/A2A-SERVER.md`, `docs/AGENT_PROTOCOLS_GUIDE.md`, `docs/CLOUD_AGENT.md` -- **Routing & resilience**: `docs/AUTO-COMBO.md`, `docs/RESILIENCE_GUIDE.md` -- **Security**: `docs/AUTHZ_GUIDE.md`, `docs/GUARDRAILS.md`, `docs/COMPLIANCE.md`, `docs/STEALTH_GUIDE.md` -- **Extensibility**: `docs/SKILLS.md`, `docs/MEMORY.md`, `docs/EVALS.md`, `docs/WEBHOOKS.md`, `docs/REASONING_REPLAY.md` -- **Platform**: `docs/ELECTRON_GUIDE.md`, `docs/TUNNELS_GUIDE.md` +- **Architecture & Reference**: `docs/architecture/ARCHITECTURE.md`, `docs/architecture/CODEBASE_DOCUMENTATION.md`, `docs/architecture/REPOSITORY_MAP.md`, `docs/reference/API_REFERENCE.md`, `docs/reference/PROVIDER_REFERENCE.md`, `docs/reference/openapi.yaml` +- **Operator guides**: `docs/guides/USER_GUIDE.md`, `docs/reference/CLI-TOOLS.md`, `docs/guides/TROUBLESHOOTING.md`, `docs/ops/COVERAGE_PLAN.md` +- **Protocols**: `docs/frameworks/MCP-SERVER.md`, `docs/frameworks/A2A-SERVER.md`, `docs/frameworks/AGENT_PROTOCOLS_GUIDE.md`, `docs/frameworks/CLOUD_AGENT.md` +- **Routing & resilience**: `docs/routing/AUTO-COMBO.md`, `docs/architecture/RESILIENCE_GUIDE.md` +- **Security**: `docs/architecture/AUTHZ_GUIDE.md`, `docs/security/GUARDRAILS.md`, `docs/security/COMPLIANCE.md`, `docs/security/STEALTH_GUIDE.md` +- **Extensibility**: `docs/frameworks/SKILLS.md`, `docs/frameworks/MEMORY.md`, `docs/frameworks/EVALS.md`, `docs/frameworks/WEBHOOKS.md`, `docs/routing/REASONING_REPLAY.md` +- **Platform**: `docs/guides/ELECTRON_GUIDE.md`, `docs/ops/TUNNELS_GUIDE.md` - **AI agents**: `CLAUDE.md`, `AGENTS.md`, `GEMINI.md` diff --git a/docs/i18n/tr/CHANGELOG.md b/docs/i18n/tr/CHANGELOG.md index 5b86d20a6b..6a76f5d58b 100644 --- a/docs/i18n/tr/CHANGELOG.md +++ b/docs/i18n/tr/CHANGELOG.md @@ -1310,7 +1310,7 @@ We identified that **155 community PRs** across the entire project history (from - **33 New API Key Providers:** Massive provider expansion adding DeepInfra, Vercel AI Gateway, Lambda AI, SambaNova, nScale, OVHcloud AI, Baseten, PublicAI, Moonshot AI, Meta Llama API, v0 (Vercel), Morph, Featherless AI, FriendliAI, LlamaGate, Galadriel, Weights & Biases Inference, Volcengine, AI21 Labs, Venice.ai, Codestral, Upstage, Maritalk, Xiaomi MiMo, Inference.net, NanoGPT, Predibase, Bytez, Heroku AI, Databricks, Snowflake Cortex, and GigaChat (Sber). OmniRoute now supports **100+ providers** (4 Free + 8 OAuth + 91 API Key + Custom compatible) - **Global Email Privacy Toggle:** Added a persistent eye-icon toggle button across all dashboard pages (Providers, Usage Limits, Playground) that reveals or hides masked email addresses. Toggle state is stored in localStorage and synced globally via Zustand store - **Documentation Refresh:** Updated README, ARCHITECTURE, FEATURES, AGENTS.md, and API_REFERENCE for v3.6.2 with accurate provider counts (100+), new executor list, and system API documentation -- **Uninstall Guide:** Created comprehensive `docs/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) +- **Uninstall Guide:** Created comprehensive `docs/guides/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) ### 🐛 Bug Fixes diff --git a/docs/i18n/tr/CONTRIBUTING.md b/docs/i18n/tr/CONTRIBUTING.md index 01cb7453ee..2d5a1cf7b1 100644 --- a/docs/i18n/tr/CONTRIBUTING.md +++ b/docs/i18n/tr/CONTRIBUTING.md @@ -153,7 +153,7 @@ Coverage notes: - If a PR changes production code in `src/`, `open-sse/`, `electron/`, or `bin/`, it must add or update automated tests in the same PR - `npm run coverage:report` prints the detailed file-by-file report from the latest coverage run - `npm run test:coverage:legacy` preserves the older metric for historical comparison -- See `docs/COVERAGE_PLAN.md` for the phased coverage improvement roadmap +- See `docs/ops/COVERAGE_PLAN.md` for the phased coverage improvement roadmap ### Pull Request Requirements @@ -305,7 +305,7 @@ Releases are managed via the `/generate-release` workflow. When a new GitHub Rel ## Getting Help -- **Architecture**: See [`docs/ARCHITECTURE.md`](docs/ARCHITECTURE.md) -- **API Reference**: See [`docs/API_REFERENCE.md`](docs/API_REFERENCE.md) +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](docs/architecture/ARCHITECTURE.md) +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](docs/reference/API_REFERENCE.md) - **Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) - **ADRs**: See `docs/adr/` for architectural decision records diff --git a/docs/i18n/tr/README.md b/docs/i18n/tr/README.md index 9e73fd82af..7913d08756 100644 --- a/docs/i18n/tr/README.md +++ b/docs/i18n/tr/README.md @@ -2267,25 +2267,25 @@ Se não quiser criar credenciais próprias agora, ainda é possível usar o flux ## Belgeler -| Document | Description | -| -------------------------------------------------------- | --------------------------------------------------- | -| [User Guide](docs/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | -| [API Reference](docs/API_REFERENCE.md) | All endpoints with examples | -| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | -| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | -| [Auto-Combo Engine](docs/AUTO-COMBO.md) | 6-factor scoring, mode packs, self-healing | -| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | -| [Troubleshooting](docs/TROUBLESHOOTING.md) | Common problems and solutions | -| [Architecture](docs/ARCHITECTURE.md) | System architecture and internals | -| [Codebase Documentation](docs/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | -| [Uninstall Guide](docs/UNINSTALL.md) | Clean removal for all install methods | -| [Environment Config](docs/ENVIRONMENT.md) | Complete `.env` variables and references | -| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | -| [OpenAPI Spec](docs/openapi.yaml) | OpenAPI 3.0 specification | -| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | -| [VM Deployment](docs/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | -| [Features Gallery](docs/FEATURES.md) | Visual dashboard tour with screenshots | -| [Release Checklist](docs/RELEASE_CHECKLIST.md) | Pre-release validation steps | +| Document | Description | +| --------------------------------------------------------------------- | --------------------------------------------------- | +| [User Guide](docs/guides/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | +| [API Reference](docs/reference/API_REFERENCE.md) | All endpoints with examples | +| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | +| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | +| [Auto-Combo Engine](docs/routing/AUTO-COMBO.md) | 6-factor scoring, mode packs, self-healing | +| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | +| [Troubleshooting](docs/guides/TROUBLESHOOTING.md) | Common problems and solutions | +| [Architecture](docs/architecture/ARCHITECTURE.md) | System architecture and internals | +| [Codebase Documentation](docs/architecture/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | +| [Uninstall Guide](docs/guides/UNINSTALL.md) | Clean removal for all install methods | +| [Environment Config](docs/reference/ENVIRONMENT.md) | Complete `.env` variables and references | +| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | +| [OpenAPI Spec](docs/reference/openapi.yaml) | OpenAPI 3.0 specification | +| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | +| [VM Deployment](docs/ops/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | +| [Features Gallery](docs/guides/FEATURES.md) | Visual dashboard tour with screenshots | +| [Release Checklist](docs/ops/RELEASE_CHECKLIST.md) | Pre-release validation steps | --- diff --git a/docs/i18n/tr/docs/ARCHITECTURE.md b/docs/i18n/tr/docs/architecture/ARCHITECTURE.md similarity index 100% rename from docs/i18n/tr/docs/ARCHITECTURE.md rename to docs/i18n/tr/docs/architecture/ARCHITECTURE.md diff --git a/docs/i18n/tr/docs/CODEBASE_DOCUMENTATION.md b/docs/i18n/tr/docs/architecture/CODEBASE_DOCUMENTATION.md similarity index 100% rename from docs/i18n/tr/docs/CODEBASE_DOCUMENTATION.md rename to docs/i18n/tr/docs/architecture/CODEBASE_DOCUMENTATION.md diff --git a/docs/i18n/tr/docs/A2A-SERVER.md b/docs/i18n/tr/docs/frameworks/A2A-SERVER.md similarity index 100% rename from docs/i18n/tr/docs/A2A-SERVER.md rename to docs/i18n/tr/docs/frameworks/A2A-SERVER.md diff --git a/docs/i18n/tr/docs/MCP-SERVER.md b/docs/i18n/tr/docs/frameworks/MCP-SERVER.md similarity index 100% rename from docs/i18n/tr/docs/MCP-SERVER.md rename to docs/i18n/tr/docs/frameworks/MCP-SERVER.md diff --git a/docs/i18n/tr/docs/FEATURES.md b/docs/i18n/tr/docs/guides/FEATURES.md similarity index 100% rename from docs/i18n/tr/docs/FEATURES.md rename to docs/i18n/tr/docs/guides/FEATURES.md diff --git a/docs/i18n/tr/docs/I18N.md b/docs/i18n/tr/docs/guides/I18N.md similarity index 99% rename from docs/i18n/tr/docs/I18N.md rename to docs/i18n/tr/docs/guides/I18N.md index 372ee8fbe6..6ecb94e2af 100644 --- a/docs/i18n/tr/docs/I18N.md +++ b/docs/i18n/tr/docs/guides/I18N.md @@ -420,7 +420,7 @@ The generator originally used `code: "in"` (deprecated Google Translate code) fo ### `docs/i18n/README.md` Is Auto-Generated -The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/I18N.md` (this file) for hand-written documentation that should persist. +The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/guides/I18N.md` (this file) for hand-written documentation that should persist. ### External Untranslatable Keys List diff --git a/docs/i18n/tr/docs/TROUBLESHOOTING.md b/docs/i18n/tr/docs/guides/TROUBLESHOOTING.md similarity index 98% rename from docs/i18n/tr/docs/TROUBLESHOOTING.md rename to docs/i18n/tr/docs/guides/TROUBLESHOOTING.md index 982b8ab94e..626660e0ee 100644 --- a/docs/i18n/tr/docs/TROUBLESHOOTING.md +++ b/docs/i18n/tr/docs/guides/TROUBLESHOOTING.md @@ -335,7 +335,7 @@ You can ignore this section if you do not run RAG or agent pipelines behind Omni ## Still Stuck? - **GitHub Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) -- **Architecture**: See [`docs/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details -- **API Reference**: See [`docs/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints - **Health Dashboard**: Check **Dashboard → Health** for real-time system status - **Translator**: Use **Dashboard → Translator** to debug format issues diff --git a/docs/i18n/tr/docs/UNINSTALL.md b/docs/i18n/tr/docs/guides/UNINSTALL.md similarity index 100% rename from docs/i18n/tr/docs/UNINSTALL.md rename to docs/i18n/tr/docs/guides/UNINSTALL.md diff --git a/docs/i18n/tr/docs/USER_GUIDE.md b/docs/i18n/tr/docs/guides/USER_GUIDE.md similarity index 100% rename from docs/i18n/tr/docs/USER_GUIDE.md rename to docs/i18n/tr/docs/guides/USER_GUIDE.md diff --git a/docs/i18n/tr/docs/COVERAGE_PLAN.md b/docs/i18n/tr/docs/ops/COVERAGE_PLAN.md similarity index 100% rename from docs/i18n/tr/docs/COVERAGE_PLAN.md rename to docs/i18n/tr/docs/ops/COVERAGE_PLAN.md diff --git a/docs/i18n/tr/docs/FLY_IO_DEPLOYMENT_GUIDE.md b/docs/i18n/tr/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/tr/docs/FLY_IO_DEPLOYMENT_GUIDE.md rename to docs/i18n/tr/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/tr/docs/RELEASE_CHECKLIST.md b/docs/i18n/tr/docs/ops/RELEASE_CHECKLIST.md similarity index 94% rename from docs/i18n/tr/docs/RELEASE_CHECKLIST.md rename to docs/i18n/tr/docs/ops/RELEASE_CHECKLIST.md index a9ed14e791..23b681a69e 100644 --- a/docs/i18n/tr/docs/RELEASE_CHECKLIST.md +++ b/docs/i18n/tr/docs/ops/RELEASE_CHECKLIST.md @@ -16,14 +16,14 @@ Use this checklist before tagging or publishing a new OmniRoute release. ## API Docs -1. Update `docs/openapi.yaml`: +1. Update `docs/reference/openapi.yaml`: - `info.version` must equal `package.json` version. 2. Validate endpoint examples if API contracts changed. ## Runtime Docs -1. Review `docs/ARCHITECTURE.md` for storage/runtime drift. -2. Review `docs/TROUBLESHOOTING.md` for env var and operational drift. +1. Review `docs/architecture/ARCHITECTURE.md` for storage/runtime drift. +2. Review `docs/guides/TROUBLESHOOTING.md` for env var and operational drift. 3. Verify the release/runtime Node.js version still satisfies the supported secure floor: - `>=20.20.2 <21` or `>=22.22.2 <23` - `npm run check:node-runtime` diff --git a/docs/i18n/tr/docs/VM_DEPLOYMENT_GUIDE.md b/docs/i18n/tr/docs/ops/VM_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/tr/docs/VM_DEPLOYMENT_GUIDE.md rename to docs/i18n/tr/docs/ops/VM_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/tr/docs/API_REFERENCE.md b/docs/i18n/tr/docs/reference/API_REFERENCE.md similarity index 100% rename from docs/i18n/tr/docs/API_REFERENCE.md rename to docs/i18n/tr/docs/reference/API_REFERENCE.md diff --git a/docs/i18n/tr/docs/CLI-TOOLS.md b/docs/i18n/tr/docs/reference/CLI-TOOLS.md similarity index 100% rename from docs/i18n/tr/docs/CLI-TOOLS.md rename to docs/i18n/tr/docs/reference/CLI-TOOLS.md diff --git a/docs/i18n/tr/docs/ENVIRONMENT.md b/docs/i18n/tr/docs/reference/ENVIRONMENT.md similarity index 100% rename from docs/i18n/tr/docs/ENVIRONMENT.md rename to docs/i18n/tr/docs/reference/ENVIRONMENT.md diff --git a/docs/i18n/tr/docs/AUTO-COMBO.md b/docs/i18n/tr/docs/routing/AUTO-COMBO.md similarity index 100% rename from docs/i18n/tr/docs/AUTO-COMBO.md rename to docs/i18n/tr/docs/routing/AUTO-COMBO.md diff --git a/docs/i18n/tr/llm.txt b/docs/i18n/tr/llm.txt index 94e60c1ba6..ba869b155c 100644 --- a/docs/i18n/tr/llm.txt +++ b/docs/i18n/tr/llm.txt @@ -357,11 +357,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### MCP Server (37 Tools) | Category | Tools | |------------|-------| -| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/MCP-SERVER.md` for full inventory) | +| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/frameworks/MCP-SERVER.md` for full inventory) | | Memory (3) | `memory_search`, `memory_add`, `memory_clear` | | Skills (4) | `skills_list`, `skills_enable`, `skills_execute`, `skills_executions` | -**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/MCP-SERVER.md`. +**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/frameworks/MCP-SERVER.md`. ### Provider Categories @@ -472,7 +472,7 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo 20. **Guardrails framework** in `src/lib/guardrails/` — hot-reloadable registry. Built-ins (priority-ordered): `vision-bridge` (5) → `pii-masker` (10) → `prompt-injection` (20). Fail-open model: exceptions never block traffic. Per-request opt-out via `x-omniroute-disabled-guardrails` header. -21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/AUTHZ_GUIDE.md`. +21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/architecture/AUTHZ_GUIDE.md`. 22. **Three resilience layers** are distinct (do not conflate them): - **Provider Circuit Breaker** (`src/shared/utils/circuitBreaker.ts`) — whole-provider scope. @@ -489,11 +489,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo - **MCP server expanded to 37 tools** (30 base + 3 memory + 4 skills) across ~13 scopes - **OAuth providers expanded to 14**: added Qwen, Kiro, Qoder, Gemini, Windsurf, GitLab Duo - **Coverage gate raised to 75/75/75/70** (was 60% across the board) — measured ~82% -- **Reasoning replay** (`docs/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams +- **Reasoning replay** (`docs/routing/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams - **Compliance + Evals + Webhooks** documentation introduced -- **Stealth guide** (`docs/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration -- **Tunnels guide** (`docs/TUNNELS_GUIDE.md`) — Cloudflare tunnel management -- **Electron guide** (`docs/ELECTRON_GUIDE.md`) — desktop app build + signing +- **Stealth guide** (`docs/security/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration +- **Tunnels guide** (`docs/ops/TUNNELS_GUIDE.md`) — Cloudflare tunnel management +- **Electron guide** (`docs/guides/ELECTRON_GUIDE.md`) — desktop app build + signing ## Links @@ -505,11 +505,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### Documentation Index -- **Architecture & Reference**: `docs/ARCHITECTURE.md`, `docs/CODEBASE_DOCUMENTATION.md`, `docs/REPOSITORY_MAP.md`, `docs/API_REFERENCE.md`, `docs/PROVIDER_REFERENCE.md`, `docs/openapi.yaml` -- **Operator guides**: `docs/USER_GUIDE.md`, `docs/CLI-TOOLS.md`, `docs/TROUBLESHOOTING.md`, `docs/COVERAGE_PLAN.md` -- **Protocols**: `docs/MCP-SERVER.md`, `docs/A2A-SERVER.md`, `docs/AGENT_PROTOCOLS_GUIDE.md`, `docs/CLOUD_AGENT.md` -- **Routing & resilience**: `docs/AUTO-COMBO.md`, `docs/RESILIENCE_GUIDE.md` -- **Security**: `docs/AUTHZ_GUIDE.md`, `docs/GUARDRAILS.md`, `docs/COMPLIANCE.md`, `docs/STEALTH_GUIDE.md` -- **Extensibility**: `docs/SKILLS.md`, `docs/MEMORY.md`, `docs/EVALS.md`, `docs/WEBHOOKS.md`, `docs/REASONING_REPLAY.md` -- **Platform**: `docs/ELECTRON_GUIDE.md`, `docs/TUNNELS_GUIDE.md` +- **Architecture & Reference**: `docs/architecture/ARCHITECTURE.md`, `docs/architecture/CODEBASE_DOCUMENTATION.md`, `docs/architecture/REPOSITORY_MAP.md`, `docs/reference/API_REFERENCE.md`, `docs/reference/PROVIDER_REFERENCE.md`, `docs/reference/openapi.yaml` +- **Operator guides**: `docs/guides/USER_GUIDE.md`, `docs/reference/CLI-TOOLS.md`, `docs/guides/TROUBLESHOOTING.md`, `docs/ops/COVERAGE_PLAN.md` +- **Protocols**: `docs/frameworks/MCP-SERVER.md`, `docs/frameworks/A2A-SERVER.md`, `docs/frameworks/AGENT_PROTOCOLS_GUIDE.md`, `docs/frameworks/CLOUD_AGENT.md` +- **Routing & resilience**: `docs/routing/AUTO-COMBO.md`, `docs/architecture/RESILIENCE_GUIDE.md` +- **Security**: `docs/architecture/AUTHZ_GUIDE.md`, `docs/security/GUARDRAILS.md`, `docs/security/COMPLIANCE.md`, `docs/security/STEALTH_GUIDE.md` +- **Extensibility**: `docs/frameworks/SKILLS.md`, `docs/frameworks/MEMORY.md`, `docs/frameworks/EVALS.md`, `docs/frameworks/WEBHOOKS.md`, `docs/routing/REASONING_REPLAY.md` +- **Platform**: `docs/guides/ELECTRON_GUIDE.md`, `docs/ops/TUNNELS_GUIDE.md` - **AI agents**: `CLAUDE.md`, `AGENTS.md`, `GEMINI.md` diff --git a/docs/i18n/uk-UA/CHANGELOG.md b/docs/i18n/uk-UA/CHANGELOG.md index bd741fc54a..3dbc00245a 100644 --- a/docs/i18n/uk-UA/CHANGELOG.md +++ b/docs/i18n/uk-UA/CHANGELOG.md @@ -1310,7 +1310,7 @@ We identified that **155 community PRs** across the entire project history (from - **33 New API Key Providers:** Massive provider expansion adding DeepInfra, Vercel AI Gateway, Lambda AI, SambaNova, nScale, OVHcloud AI, Baseten, PublicAI, Moonshot AI, Meta Llama API, v0 (Vercel), Morph, Featherless AI, FriendliAI, LlamaGate, Galadriel, Weights & Biases Inference, Volcengine, AI21 Labs, Venice.ai, Codestral, Upstage, Maritalk, Xiaomi MiMo, Inference.net, NanoGPT, Predibase, Bytez, Heroku AI, Databricks, Snowflake Cortex, and GigaChat (Sber). OmniRoute now supports **100+ providers** (4 Free + 8 OAuth + 91 API Key + Custom compatible) - **Global Email Privacy Toggle:** Added a persistent eye-icon toggle button across all dashboard pages (Providers, Usage Limits, Playground) that reveals or hides masked email addresses. Toggle state is stored in localStorage and synced globally via Zustand store - **Documentation Refresh:** Updated README, ARCHITECTURE, FEATURES, AGENTS.md, and API_REFERENCE for v3.6.2 with accurate provider counts (100+), new executor list, and system API documentation -- **Uninstall Guide:** Created comprehensive `docs/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) +- **Uninstall Guide:** Created comprehensive `docs/guides/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) ### 🐛 Bug Fixes diff --git a/docs/i18n/uk-UA/CONTRIBUTING.md b/docs/i18n/uk-UA/CONTRIBUTING.md index 3429c4b314..62ca1f5c6b 100644 --- a/docs/i18n/uk-UA/CONTRIBUTING.md +++ b/docs/i18n/uk-UA/CONTRIBUTING.md @@ -153,7 +153,7 @@ Coverage notes: - If a PR changes production code in `src/`, `open-sse/`, `electron/`, or `bin/`, it must add or update automated tests in the same PR - `npm run coverage:report` prints the detailed file-by-file report from the latest coverage run - `npm run test:coverage:legacy` preserves the older metric for historical comparison -- See `docs/COVERAGE_PLAN.md` for the phased coverage improvement roadmap +- See `docs/ops/COVERAGE_PLAN.md` for the phased coverage improvement roadmap ### Pull Request Requirements @@ -305,7 +305,7 @@ Releases are managed via the `/generate-release` workflow. When a new GitHub Rel ## Getting Help -- **Architecture**: See [`docs/ARCHITECTURE.md`](docs/ARCHITECTURE.md) -- **API Reference**: See [`docs/API_REFERENCE.md`](docs/API_REFERENCE.md) +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](docs/architecture/ARCHITECTURE.md) +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](docs/reference/API_REFERENCE.md) - **Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) - **ADRs**: See `docs/adr/` for architectural decision records diff --git a/docs/i18n/uk-UA/README.md b/docs/i18n/uk-UA/README.md index 164291d59e..2b7cd0488e 100644 --- a/docs/i18n/uk-UA/README.md +++ b/docs/i18n/uk-UA/README.md @@ -2267,25 +2267,25 @@ Se não quiser criar credenciais próprias agora, ainda é possível usar o flux ## Документація -| Document | Description | -| -------------------------------------------------------- | --------------------------------------------------- | -| [User Guide](docs/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | -| [API Reference](docs/API_REFERENCE.md) | All endpoints with examples | -| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | -| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | -| [Auto-Combo Engine](docs/AUTO-COMBO.md) | 6-factor scoring, mode packs, self-healing | -| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | -| [Troubleshooting](docs/TROUBLESHOOTING.md) | Common problems and solutions | -| [Architecture](docs/ARCHITECTURE.md) | System architecture and internals | -| [Codebase Documentation](docs/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | -| [Uninstall Guide](docs/UNINSTALL.md) | Clean removal for all install methods | -| [Environment Config](docs/ENVIRONMENT.md) | Complete `.env` variables and references | -| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | -| [OpenAPI Spec](docs/openapi.yaml) | OpenAPI 3.0 specification | -| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | -| [VM Deployment](docs/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | -| [Features Gallery](docs/FEATURES.md) | Visual dashboard tour with screenshots | -| [Release Checklist](docs/RELEASE_CHECKLIST.md) | Pre-release validation steps | +| Document | Description | +| --------------------------------------------------------------------- | --------------------------------------------------- | +| [User Guide](docs/guides/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | +| [API Reference](docs/reference/API_REFERENCE.md) | All endpoints with examples | +| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | +| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | +| [Auto-Combo Engine](docs/routing/AUTO-COMBO.md) | 6-factor scoring, mode packs, self-healing | +| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | +| [Troubleshooting](docs/guides/TROUBLESHOOTING.md) | Common problems and solutions | +| [Architecture](docs/architecture/ARCHITECTURE.md) | System architecture and internals | +| [Codebase Documentation](docs/architecture/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | +| [Uninstall Guide](docs/guides/UNINSTALL.md) | Clean removal for all install methods | +| [Environment Config](docs/reference/ENVIRONMENT.md) | Complete `.env` variables and references | +| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | +| [OpenAPI Spec](docs/reference/openapi.yaml) | OpenAPI 3.0 specification | +| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | +| [VM Deployment](docs/ops/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | +| [Features Gallery](docs/guides/FEATURES.md) | Visual dashboard tour with screenshots | +| [Release Checklist](docs/ops/RELEASE_CHECKLIST.md) | Pre-release validation steps | --- diff --git a/docs/i18n/uk-UA/docs/ARCHITECTURE.md b/docs/i18n/uk-UA/docs/architecture/ARCHITECTURE.md similarity index 100% rename from docs/i18n/uk-UA/docs/ARCHITECTURE.md rename to docs/i18n/uk-UA/docs/architecture/ARCHITECTURE.md diff --git a/docs/i18n/uk-UA/docs/CODEBASE_DOCUMENTATION.md b/docs/i18n/uk-UA/docs/architecture/CODEBASE_DOCUMENTATION.md similarity index 100% rename from docs/i18n/uk-UA/docs/CODEBASE_DOCUMENTATION.md rename to docs/i18n/uk-UA/docs/architecture/CODEBASE_DOCUMENTATION.md diff --git a/docs/i18n/uk-UA/docs/A2A-SERVER.md b/docs/i18n/uk-UA/docs/frameworks/A2A-SERVER.md similarity index 100% rename from docs/i18n/uk-UA/docs/A2A-SERVER.md rename to docs/i18n/uk-UA/docs/frameworks/A2A-SERVER.md diff --git a/docs/i18n/uk-UA/docs/MCP-SERVER.md b/docs/i18n/uk-UA/docs/frameworks/MCP-SERVER.md similarity index 100% rename from docs/i18n/uk-UA/docs/MCP-SERVER.md rename to docs/i18n/uk-UA/docs/frameworks/MCP-SERVER.md diff --git a/docs/i18n/uk-UA/docs/FEATURES.md b/docs/i18n/uk-UA/docs/guides/FEATURES.md similarity index 100% rename from docs/i18n/uk-UA/docs/FEATURES.md rename to docs/i18n/uk-UA/docs/guides/FEATURES.md diff --git a/docs/i18n/uk-UA/docs/I18N.md b/docs/i18n/uk-UA/docs/guides/I18N.md similarity index 99% rename from docs/i18n/uk-UA/docs/I18N.md rename to docs/i18n/uk-UA/docs/guides/I18N.md index b468c09940..0b0e77329b 100644 --- a/docs/i18n/uk-UA/docs/I18N.md +++ b/docs/i18n/uk-UA/docs/guides/I18N.md @@ -420,7 +420,7 @@ The generator originally used `code: "in"` (deprecated Google Translate code) fo ### `docs/i18n/README.md` Is Auto-Generated -The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/I18N.md` (this file) for hand-written documentation that should persist. +The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/guides/I18N.md` (this file) for hand-written documentation that should persist. ### External Untranslatable Keys List diff --git a/docs/i18n/uk-UA/docs/TROUBLESHOOTING.md b/docs/i18n/uk-UA/docs/guides/TROUBLESHOOTING.md similarity index 98% rename from docs/i18n/uk-UA/docs/TROUBLESHOOTING.md rename to docs/i18n/uk-UA/docs/guides/TROUBLESHOOTING.md index 067ef13b9b..e1a0a4d0b1 100644 --- a/docs/i18n/uk-UA/docs/TROUBLESHOOTING.md +++ b/docs/i18n/uk-UA/docs/guides/TROUBLESHOOTING.md @@ -335,7 +335,7 @@ You can ignore this section if you do not run RAG or agent pipelines behind Omni ## Still Stuck? - **GitHub Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) -- **Architecture**: See [`docs/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details -- **API Reference**: See [`docs/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints - **Health Dashboard**: Check **Dashboard → Health** for real-time system status - **Translator**: Use **Dashboard → Translator** to debug format issues diff --git a/docs/i18n/uk-UA/docs/UNINSTALL.md b/docs/i18n/uk-UA/docs/guides/UNINSTALL.md similarity index 100% rename from docs/i18n/uk-UA/docs/UNINSTALL.md rename to docs/i18n/uk-UA/docs/guides/UNINSTALL.md diff --git a/docs/i18n/uk-UA/docs/USER_GUIDE.md b/docs/i18n/uk-UA/docs/guides/USER_GUIDE.md similarity index 100% rename from docs/i18n/uk-UA/docs/USER_GUIDE.md rename to docs/i18n/uk-UA/docs/guides/USER_GUIDE.md diff --git a/docs/i18n/uk-UA/docs/COVERAGE_PLAN.md b/docs/i18n/uk-UA/docs/ops/COVERAGE_PLAN.md similarity index 100% rename from docs/i18n/uk-UA/docs/COVERAGE_PLAN.md rename to docs/i18n/uk-UA/docs/ops/COVERAGE_PLAN.md diff --git a/docs/i18n/uk-UA/docs/FLY_IO_DEPLOYMENT_GUIDE.md b/docs/i18n/uk-UA/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/uk-UA/docs/FLY_IO_DEPLOYMENT_GUIDE.md rename to docs/i18n/uk-UA/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/uk-UA/docs/RELEASE_CHECKLIST.md b/docs/i18n/uk-UA/docs/ops/RELEASE_CHECKLIST.md similarity index 94% rename from docs/i18n/uk-UA/docs/RELEASE_CHECKLIST.md rename to docs/i18n/uk-UA/docs/ops/RELEASE_CHECKLIST.md index c2461ce436..c3905bef2f 100644 --- a/docs/i18n/uk-UA/docs/RELEASE_CHECKLIST.md +++ b/docs/i18n/uk-UA/docs/ops/RELEASE_CHECKLIST.md @@ -16,14 +16,14 @@ Use this checklist before tagging or publishing a new OmniRoute release. ## API Docs -1. Update `docs/openapi.yaml`: +1. Update `docs/reference/openapi.yaml`: - `info.version` must equal `package.json` version. 2. Validate endpoint examples if API contracts changed. ## Runtime Docs -1. Review `docs/ARCHITECTURE.md` for storage/runtime drift. -2. Review `docs/TROUBLESHOOTING.md` for env var and operational drift. +1. Review `docs/architecture/ARCHITECTURE.md` for storage/runtime drift. +2. Review `docs/guides/TROUBLESHOOTING.md` for env var and operational drift. 3. Verify the release/runtime Node.js version still satisfies the supported secure floor: - `>=20.20.2 <21` or `>=22.22.2 <23` - `npm run check:node-runtime` diff --git a/docs/i18n/uk-UA/docs/VM_DEPLOYMENT_GUIDE.md b/docs/i18n/uk-UA/docs/ops/VM_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/uk-UA/docs/VM_DEPLOYMENT_GUIDE.md rename to docs/i18n/uk-UA/docs/ops/VM_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/uk-UA/docs/API_REFERENCE.md b/docs/i18n/uk-UA/docs/reference/API_REFERENCE.md similarity index 100% rename from docs/i18n/uk-UA/docs/API_REFERENCE.md rename to docs/i18n/uk-UA/docs/reference/API_REFERENCE.md diff --git a/docs/i18n/uk-UA/docs/CLI-TOOLS.md b/docs/i18n/uk-UA/docs/reference/CLI-TOOLS.md similarity index 100% rename from docs/i18n/uk-UA/docs/CLI-TOOLS.md rename to docs/i18n/uk-UA/docs/reference/CLI-TOOLS.md diff --git a/docs/i18n/uk-UA/docs/ENVIRONMENT.md b/docs/i18n/uk-UA/docs/reference/ENVIRONMENT.md similarity index 100% rename from docs/i18n/uk-UA/docs/ENVIRONMENT.md rename to docs/i18n/uk-UA/docs/reference/ENVIRONMENT.md diff --git a/docs/i18n/uk-UA/docs/AUTO-COMBO.md b/docs/i18n/uk-UA/docs/routing/AUTO-COMBO.md similarity index 100% rename from docs/i18n/uk-UA/docs/AUTO-COMBO.md rename to docs/i18n/uk-UA/docs/routing/AUTO-COMBO.md diff --git a/docs/i18n/uk-UA/llm.txt b/docs/i18n/uk-UA/llm.txt index 7547505898..6f3fc024b0 100644 --- a/docs/i18n/uk-UA/llm.txt +++ b/docs/i18n/uk-UA/llm.txt @@ -357,11 +357,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### MCP Server (37 Tools) | Category | Tools | |------------|-------| -| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/MCP-SERVER.md` for full inventory) | +| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/frameworks/MCP-SERVER.md` for full inventory) | | Memory (3) | `memory_search`, `memory_add`, `memory_clear` | | Skills (4) | `skills_list`, `skills_enable`, `skills_execute`, `skills_executions` | -**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/MCP-SERVER.md`. +**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/frameworks/MCP-SERVER.md`. ### Provider Categories @@ -472,7 +472,7 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo 20. **Guardrails framework** in `src/lib/guardrails/` — hot-reloadable registry. Built-ins (priority-ordered): `vision-bridge` (5) → `pii-masker` (10) → `prompt-injection` (20). Fail-open model: exceptions never block traffic. Per-request opt-out via `x-omniroute-disabled-guardrails` header. -21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/AUTHZ_GUIDE.md`. +21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/architecture/AUTHZ_GUIDE.md`. 22. **Three resilience layers** are distinct (do not conflate them): - **Provider Circuit Breaker** (`src/shared/utils/circuitBreaker.ts`) — whole-provider scope. @@ -489,11 +489,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo - **MCP server expanded to 37 tools** (30 base + 3 memory + 4 skills) across ~13 scopes - **OAuth providers expanded to 14**: added Qwen, Kiro, Qoder, Gemini, Windsurf, GitLab Duo - **Coverage gate raised to 75/75/75/70** (was 60% across the board) — measured ~82% -- **Reasoning replay** (`docs/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams +- **Reasoning replay** (`docs/routing/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams - **Compliance + Evals + Webhooks** documentation introduced -- **Stealth guide** (`docs/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration -- **Tunnels guide** (`docs/TUNNELS_GUIDE.md`) — Cloudflare tunnel management -- **Electron guide** (`docs/ELECTRON_GUIDE.md`) — desktop app build + signing +- **Stealth guide** (`docs/security/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration +- **Tunnels guide** (`docs/ops/TUNNELS_GUIDE.md`) — Cloudflare tunnel management +- **Electron guide** (`docs/guides/ELECTRON_GUIDE.md`) — desktop app build + signing ## Links @@ -505,11 +505,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### Documentation Index -- **Architecture & Reference**: `docs/ARCHITECTURE.md`, `docs/CODEBASE_DOCUMENTATION.md`, `docs/REPOSITORY_MAP.md`, `docs/API_REFERENCE.md`, `docs/PROVIDER_REFERENCE.md`, `docs/openapi.yaml` -- **Operator guides**: `docs/USER_GUIDE.md`, `docs/CLI-TOOLS.md`, `docs/TROUBLESHOOTING.md`, `docs/COVERAGE_PLAN.md` -- **Protocols**: `docs/MCP-SERVER.md`, `docs/A2A-SERVER.md`, `docs/AGENT_PROTOCOLS_GUIDE.md`, `docs/CLOUD_AGENT.md` -- **Routing & resilience**: `docs/AUTO-COMBO.md`, `docs/RESILIENCE_GUIDE.md` -- **Security**: `docs/AUTHZ_GUIDE.md`, `docs/GUARDRAILS.md`, `docs/COMPLIANCE.md`, `docs/STEALTH_GUIDE.md` -- **Extensibility**: `docs/SKILLS.md`, `docs/MEMORY.md`, `docs/EVALS.md`, `docs/WEBHOOKS.md`, `docs/REASONING_REPLAY.md` -- **Platform**: `docs/ELECTRON_GUIDE.md`, `docs/TUNNELS_GUIDE.md` +- **Architecture & Reference**: `docs/architecture/ARCHITECTURE.md`, `docs/architecture/CODEBASE_DOCUMENTATION.md`, `docs/architecture/REPOSITORY_MAP.md`, `docs/reference/API_REFERENCE.md`, `docs/reference/PROVIDER_REFERENCE.md`, `docs/reference/openapi.yaml` +- **Operator guides**: `docs/guides/USER_GUIDE.md`, `docs/reference/CLI-TOOLS.md`, `docs/guides/TROUBLESHOOTING.md`, `docs/ops/COVERAGE_PLAN.md` +- **Protocols**: `docs/frameworks/MCP-SERVER.md`, `docs/frameworks/A2A-SERVER.md`, `docs/frameworks/AGENT_PROTOCOLS_GUIDE.md`, `docs/frameworks/CLOUD_AGENT.md` +- **Routing & resilience**: `docs/routing/AUTO-COMBO.md`, `docs/architecture/RESILIENCE_GUIDE.md` +- **Security**: `docs/architecture/AUTHZ_GUIDE.md`, `docs/security/GUARDRAILS.md`, `docs/security/COMPLIANCE.md`, `docs/security/STEALTH_GUIDE.md` +- **Extensibility**: `docs/frameworks/SKILLS.md`, `docs/frameworks/MEMORY.md`, `docs/frameworks/EVALS.md`, `docs/frameworks/WEBHOOKS.md`, `docs/routing/REASONING_REPLAY.md` +- **Platform**: `docs/guides/ELECTRON_GUIDE.md`, `docs/ops/TUNNELS_GUIDE.md` - **AI agents**: `CLAUDE.md`, `AGENTS.md`, `GEMINI.md` diff --git a/docs/i18n/ur/CHANGELOG.md b/docs/i18n/ur/CHANGELOG.md index 814e6bd3ba..c2f5801582 100644 --- a/docs/i18n/ur/CHANGELOG.md +++ b/docs/i18n/ur/CHANGELOG.md @@ -1310,7 +1310,7 @@ We identified that **155 community PRs** across the entire project history (from - **33 New API Key Providers:** Massive provider expansion adding DeepInfra, Vercel AI Gateway, Lambda AI, SambaNova, nScale, OVHcloud AI, Baseten, PublicAI, Moonshot AI, Meta Llama API, v0 (Vercel), Morph, Featherless AI, FriendliAI, LlamaGate, Galadriel, Weights & Biases Inference, Volcengine, AI21 Labs, Venice.ai, Codestral, Upstage, Maritalk, Xiaomi MiMo, Inference.net, NanoGPT, Predibase, Bytez, Heroku AI, Databricks, Snowflake Cortex, and GigaChat (Sber). OmniRoute now supports **100+ providers** (4 Free + 8 OAuth + 91 API Key + Custom compatible) - **Global Email Privacy Toggle:** Added a persistent eye-icon toggle button across all dashboard pages (Providers, Usage Limits, Playground) that reveals or hides masked email addresses. Toggle state is stored in localStorage and synced globally via Zustand store - **Documentation Refresh:** Updated README, ARCHITECTURE, FEATURES, AGENTS.md, and API_REFERENCE for v3.6.2 with accurate provider counts (100+), new executor list, and system API documentation -- **Uninstall Guide:** Created comprehensive `docs/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) +- **Uninstall Guide:** Created comprehensive `docs/guides/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) ### 🐛 Bug Fixes diff --git a/docs/i18n/ur/CONTRIBUTING.md b/docs/i18n/ur/CONTRIBUTING.md index 007cd4b863..c9716461fb 100644 --- a/docs/i18n/ur/CONTRIBUTING.md +++ b/docs/i18n/ur/CONTRIBUTING.md @@ -153,7 +153,7 @@ Coverage notes: - If a PR changes production code in `src/`, `open-sse/`, `electron/`, or `bin/`, it must add or update automated tests in the same PR - `npm run coverage:report` prints the detailed file-by-file report from the latest coverage run - `npm run test:coverage:legacy` preserves the older metric for historical comparison -- See `docs/COVERAGE_PLAN.md` for the phased coverage improvement roadmap +- See `docs/ops/COVERAGE_PLAN.md` for the phased coverage improvement roadmap ### Pull Request Requirements @@ -305,7 +305,7 @@ Releases are managed via the `/generate-release` workflow. When a new GitHub Rel ## Getting Help -- **Architecture**: See [`docs/ARCHITECTURE.md`](docs/ARCHITECTURE.md) -- **API Reference**: See [`docs/API_REFERENCE.md`](docs/API_REFERENCE.md) +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](docs/architecture/ARCHITECTURE.md) +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](docs/reference/API_REFERENCE.md) - **Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) - **ADRs**: See `docs/adr/` for architectural decision records diff --git a/docs/i18n/ur/README.md b/docs/i18n/ur/README.md index 49c4759369..08020c01b0 100644 --- a/docs/i18n/ur/README.md +++ b/docs/i18n/ur/README.md @@ -2267,25 +2267,25 @@ Se não quiser criar credenciais próprias agora, ainda é possível usar o flux ## Documentación -| Document | Description | -| -------------------------------------------------------- | --------------------------------------------------- | -| [User Guide](docs/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | -| [API Reference](docs/API_REFERENCE.md) | All endpoints with examples | -| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | -| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | -| [Auto-Combo Engine](docs/auto-combo.md) | 6-factor scoring, mode packs, self-healing | -| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | -| [Troubleshooting](docs/TROUBLESHOOTING.md) | Common problems and solutions | -| [Architecture](docs/ARCHITECTURE.md) | System architecture and internals | -| [Codebase Documentation](docs/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | -| [Uninstall Guide](docs/UNINSTALL.md) | Clean removal for all install methods | -| [Environment Config](docs/ENVIRONMENT.md) | Complete `.env` variables and references | -| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | -| [OpenAPI Spec](docs/openapi.yaml) | OpenAPI 3.0 specification | -| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | -| [VM Deployment](docs/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | -| [Features Gallery](docs/FEATURES.md) | Visual dashboard tour with screenshots | -| [Release Checklist](docs/RELEASE_CHECKLIST.md) | Pre-release validation steps | +| Document | Description | +| --------------------------------------------------------------------- | --------------------------------------------------- | +| [User Guide](docs/guides/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | +| [API Reference](docs/reference/API_REFERENCE.md) | All endpoints with examples | +| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | +| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | +| [Auto-Combo Engine](docs/auto-combo.md) | 6-factor scoring, mode packs, self-healing | +| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | +| [Troubleshooting](docs/guides/TROUBLESHOOTING.md) | Common problems and solutions | +| [Architecture](docs/architecture/ARCHITECTURE.md) | System architecture and internals | +| [Codebase Documentation](docs/architecture/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | +| [Uninstall Guide](docs/guides/UNINSTALL.md) | Clean removal for all install methods | +| [Environment Config](docs/reference/ENVIRONMENT.md) | Complete `.env` variables and references | +| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | +| [OpenAPI Spec](docs/reference/openapi.yaml) | OpenAPI 3.0 specification | +| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | +| [VM Deployment](docs/ops/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | +| [Features Gallery](docs/guides/FEATURES.md) | Visual dashboard tour with screenshots | +| [Release Checklist](docs/ops/RELEASE_CHECKLIST.md) | Pre-release validation steps | --- diff --git a/docs/i18n/ur/docs/ARCHITECTURE.md b/docs/i18n/ur/docs/architecture/ARCHITECTURE.md similarity index 100% rename from docs/i18n/ur/docs/ARCHITECTURE.md rename to docs/i18n/ur/docs/architecture/ARCHITECTURE.md diff --git a/docs/i18n/ur/docs/CODEBASE_DOCUMENTATION.md b/docs/i18n/ur/docs/architecture/CODEBASE_DOCUMENTATION.md similarity index 100% rename from docs/i18n/ur/docs/CODEBASE_DOCUMENTATION.md rename to docs/i18n/ur/docs/architecture/CODEBASE_DOCUMENTATION.md diff --git a/docs/i18n/ur/docs/A2A-SERVER.md b/docs/i18n/ur/docs/frameworks/A2A-SERVER.md similarity index 100% rename from docs/i18n/ur/docs/A2A-SERVER.md rename to docs/i18n/ur/docs/frameworks/A2A-SERVER.md diff --git a/docs/i18n/ur/docs/MCP-SERVER.md b/docs/i18n/ur/docs/frameworks/MCP-SERVER.md similarity index 100% rename from docs/i18n/ur/docs/MCP-SERVER.md rename to docs/i18n/ur/docs/frameworks/MCP-SERVER.md diff --git a/docs/i18n/ur/docs/FEATURES.md b/docs/i18n/ur/docs/guides/FEATURES.md similarity index 100% rename from docs/i18n/ur/docs/FEATURES.md rename to docs/i18n/ur/docs/guides/FEATURES.md diff --git a/docs/i18n/ur/docs/I18N.md b/docs/i18n/ur/docs/guides/I18N.md similarity index 99% rename from docs/i18n/ur/docs/I18N.md rename to docs/i18n/ur/docs/guides/I18N.md index d2724aef25..793396ba59 100644 --- a/docs/i18n/ur/docs/I18N.md +++ b/docs/i18n/ur/docs/guides/I18N.md @@ -420,7 +420,7 @@ The generator originally used `code: "in"` (deprecated Google Translate code) fo ### `docs/i18n/README.md` Is Auto-Generated -The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/I18N.md` (this file) for hand-written documentation that should persist. +The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/guides/I18N.md` (this file) for hand-written documentation that should persist. ### External Untranslatable Keys List diff --git a/docs/i18n/ur/docs/TROUBLESHOOTING.md b/docs/i18n/ur/docs/guides/TROUBLESHOOTING.md similarity index 98% rename from docs/i18n/ur/docs/TROUBLESHOOTING.md rename to docs/i18n/ur/docs/guides/TROUBLESHOOTING.md index 41dff9595d..43089bfd01 100644 --- a/docs/i18n/ur/docs/TROUBLESHOOTING.md +++ b/docs/i18n/ur/docs/guides/TROUBLESHOOTING.md @@ -335,7 +335,7 @@ You can ignore this section if you do not run RAG or agent pipelines behind Omni ## Still Stuck? - **GitHub Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) -- **Architecture**: See [`docs/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details -- **API Reference**: See [`docs/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints - **Health Dashboard**: Check **Dashboard → Health** for real-time system status - **Translator**: Use **Dashboard → Translator** to debug format issues diff --git a/docs/i18n/ur/docs/UNINSTALL.md b/docs/i18n/ur/docs/guides/UNINSTALL.md similarity index 100% rename from docs/i18n/ur/docs/UNINSTALL.md rename to docs/i18n/ur/docs/guides/UNINSTALL.md diff --git a/docs/i18n/ur/docs/USER_GUIDE.md b/docs/i18n/ur/docs/guides/USER_GUIDE.md similarity index 100% rename from docs/i18n/ur/docs/USER_GUIDE.md rename to docs/i18n/ur/docs/guides/USER_GUIDE.md diff --git a/docs/i18n/ur/docs/COVERAGE_PLAN.md b/docs/i18n/ur/docs/ops/COVERAGE_PLAN.md similarity index 100% rename from docs/i18n/ur/docs/COVERAGE_PLAN.md rename to docs/i18n/ur/docs/ops/COVERAGE_PLAN.md diff --git a/docs/i18n/ur/docs/FLY_IO_DEPLOYMENT_GUIDE.md b/docs/i18n/ur/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/ur/docs/FLY_IO_DEPLOYMENT_GUIDE.md rename to docs/i18n/ur/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/ur/docs/RELEASE_CHECKLIST.md b/docs/i18n/ur/docs/ops/RELEASE_CHECKLIST.md similarity index 94% rename from docs/i18n/ur/docs/RELEASE_CHECKLIST.md rename to docs/i18n/ur/docs/ops/RELEASE_CHECKLIST.md index 48dde6bfe8..2d95ec1545 100644 --- a/docs/i18n/ur/docs/RELEASE_CHECKLIST.md +++ b/docs/i18n/ur/docs/ops/RELEASE_CHECKLIST.md @@ -16,14 +16,14 @@ Use this checklist before tagging or publishing a new OmniRoute release. ## API Docs -1. Update `docs/openapi.yaml`: +1. Update `docs/reference/openapi.yaml`: - `info.version` must equal `package.json` version. 2. Validate endpoint examples if API contracts changed. ## Runtime Docs -1. Review `docs/ARCHITECTURE.md` for storage/runtime drift. -2. Review `docs/TROUBLESHOOTING.md` for env var and operational drift. +1. Review `docs/architecture/ARCHITECTURE.md` for storage/runtime drift. +2. Review `docs/guides/TROUBLESHOOTING.md` for env var and operational drift. 3. Verify the release/runtime Node.js version still satisfies the supported secure floor: - `>=20.20.2 <21` or `>=22.22.2 <23` - `npm run check:node-runtime` diff --git a/docs/i18n/ur/docs/VM_DEPLOYMENT_GUIDE.md b/docs/i18n/ur/docs/ops/VM_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/ur/docs/VM_DEPLOYMENT_GUIDE.md rename to docs/i18n/ur/docs/ops/VM_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/ur/docs/API_REFERENCE.md b/docs/i18n/ur/docs/reference/API_REFERENCE.md similarity index 100% rename from docs/i18n/ur/docs/API_REFERENCE.md rename to docs/i18n/ur/docs/reference/API_REFERENCE.md diff --git a/docs/i18n/ur/docs/CLI-TOOLS.md b/docs/i18n/ur/docs/reference/CLI-TOOLS.md similarity index 100% rename from docs/i18n/ur/docs/CLI-TOOLS.md rename to docs/i18n/ur/docs/reference/CLI-TOOLS.md diff --git a/docs/i18n/ur/docs/ENVIRONMENT.md b/docs/i18n/ur/docs/reference/ENVIRONMENT.md similarity index 100% rename from docs/i18n/ur/docs/ENVIRONMENT.md rename to docs/i18n/ur/docs/reference/ENVIRONMENT.md diff --git a/docs/i18n/ur/docs/AUTO-COMBO.md b/docs/i18n/ur/docs/routing/AUTO-COMBO.md similarity index 100% rename from docs/i18n/ur/docs/AUTO-COMBO.md rename to docs/i18n/ur/docs/routing/AUTO-COMBO.md diff --git a/docs/i18n/ur/llm.txt b/docs/i18n/ur/llm.txt index 5a161021e2..7a90c7ce3f 100644 --- a/docs/i18n/ur/llm.txt +++ b/docs/i18n/ur/llm.txt @@ -357,11 +357,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### MCP Server (37 Tools) | Category | Tools | |------------|-------| -| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/MCP-SERVER.md` for full inventory) | +| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/frameworks/MCP-SERVER.md` for full inventory) | | Memory (3) | `memory_search`, `memory_add`, `memory_clear` | | Skills (4) | `skills_list`, `skills_enable`, `skills_execute`, `skills_executions` | -**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/MCP-SERVER.md`. +**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/frameworks/MCP-SERVER.md`. ### Provider Categories @@ -472,7 +472,7 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo 20. **Guardrails framework** in `src/lib/guardrails/` — hot-reloadable registry. Built-ins (priority-ordered): `vision-bridge` (5) → `pii-masker` (10) → `prompt-injection` (20). Fail-open model: exceptions never block traffic. Per-request opt-out via `x-omniroute-disabled-guardrails` header. -21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/AUTHZ_GUIDE.md`. +21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/architecture/AUTHZ_GUIDE.md`. 22. **Three resilience layers** are distinct (do not conflate them): - **Provider Circuit Breaker** (`src/shared/utils/circuitBreaker.ts`) — whole-provider scope. @@ -489,11 +489,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo - **MCP server expanded to 37 tools** (30 base + 3 memory + 4 skills) across ~13 scopes - **OAuth providers expanded to 14**: added Qwen, Kiro, Qoder, Gemini, Windsurf, GitLab Duo - **Coverage gate raised to 75/75/75/70** (was 60% across the board) — measured ~82% -- **Reasoning replay** (`docs/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams +- **Reasoning replay** (`docs/routing/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams - **Compliance + Evals + Webhooks** documentation introduced -- **Stealth guide** (`docs/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration -- **Tunnels guide** (`docs/TUNNELS_GUIDE.md`) — Cloudflare tunnel management -- **Electron guide** (`docs/ELECTRON_GUIDE.md`) — desktop app build + signing +- **Stealth guide** (`docs/security/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration +- **Tunnels guide** (`docs/ops/TUNNELS_GUIDE.md`) — Cloudflare tunnel management +- **Electron guide** (`docs/guides/ELECTRON_GUIDE.md`) — desktop app build + signing ## Links @@ -505,11 +505,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### Documentation Index -- **Architecture & Reference**: `docs/ARCHITECTURE.md`, `docs/CODEBASE_DOCUMENTATION.md`, `docs/REPOSITORY_MAP.md`, `docs/API_REFERENCE.md`, `docs/PROVIDER_REFERENCE.md`, `docs/openapi.yaml` -- **Operator guides**: `docs/USER_GUIDE.md`, `docs/CLI-TOOLS.md`, `docs/TROUBLESHOOTING.md`, `docs/COVERAGE_PLAN.md` -- **Protocols**: `docs/MCP-SERVER.md`, `docs/A2A-SERVER.md`, `docs/AGENT_PROTOCOLS_GUIDE.md`, `docs/CLOUD_AGENT.md` -- **Routing & resilience**: `docs/AUTO-COMBO.md`, `docs/RESILIENCE_GUIDE.md` -- **Security**: `docs/AUTHZ_GUIDE.md`, `docs/GUARDRAILS.md`, `docs/COMPLIANCE.md`, `docs/STEALTH_GUIDE.md` -- **Extensibility**: `docs/SKILLS.md`, `docs/MEMORY.md`, `docs/EVALS.md`, `docs/WEBHOOKS.md`, `docs/REASONING_REPLAY.md` -- **Platform**: `docs/ELECTRON_GUIDE.md`, `docs/TUNNELS_GUIDE.md` +- **Architecture & Reference**: `docs/architecture/ARCHITECTURE.md`, `docs/architecture/CODEBASE_DOCUMENTATION.md`, `docs/architecture/REPOSITORY_MAP.md`, `docs/reference/API_REFERENCE.md`, `docs/reference/PROVIDER_REFERENCE.md`, `docs/reference/openapi.yaml` +- **Operator guides**: `docs/guides/USER_GUIDE.md`, `docs/reference/CLI-TOOLS.md`, `docs/guides/TROUBLESHOOTING.md`, `docs/ops/COVERAGE_PLAN.md` +- **Protocols**: `docs/frameworks/MCP-SERVER.md`, `docs/frameworks/A2A-SERVER.md`, `docs/frameworks/AGENT_PROTOCOLS_GUIDE.md`, `docs/frameworks/CLOUD_AGENT.md` +- **Routing & resilience**: `docs/routing/AUTO-COMBO.md`, `docs/architecture/RESILIENCE_GUIDE.md` +- **Security**: `docs/architecture/AUTHZ_GUIDE.md`, `docs/security/GUARDRAILS.md`, `docs/security/COMPLIANCE.md`, `docs/security/STEALTH_GUIDE.md` +- **Extensibility**: `docs/frameworks/SKILLS.md`, `docs/frameworks/MEMORY.md`, `docs/frameworks/EVALS.md`, `docs/frameworks/WEBHOOKS.md`, `docs/routing/REASONING_REPLAY.md` +- **Platform**: `docs/guides/ELECTRON_GUIDE.md`, `docs/ops/TUNNELS_GUIDE.md` - **AI agents**: `CLAUDE.md`, `AGENTS.md`, `GEMINI.md` diff --git a/docs/i18n/vi/CHANGELOG.md b/docs/i18n/vi/CHANGELOG.md index 8229604aeb..d3e965b790 100644 --- a/docs/i18n/vi/CHANGELOG.md +++ b/docs/i18n/vi/CHANGELOG.md @@ -1310,7 +1310,7 @@ We identified that **155 community PRs** across the entire project history (from - **33 New API Key Providers:** Massive provider expansion adding DeepInfra, Vercel AI Gateway, Lambda AI, SambaNova, nScale, OVHcloud AI, Baseten, PublicAI, Moonshot AI, Meta Llama API, v0 (Vercel), Morph, Featherless AI, FriendliAI, LlamaGate, Galadriel, Weights & Biases Inference, Volcengine, AI21 Labs, Venice.ai, Codestral, Upstage, Maritalk, Xiaomi MiMo, Inference.net, NanoGPT, Predibase, Bytez, Heroku AI, Databricks, Snowflake Cortex, and GigaChat (Sber). OmniRoute now supports **100+ providers** (4 Free + 8 OAuth + 91 API Key + Custom compatible) - **Global Email Privacy Toggle:** Added a persistent eye-icon toggle button across all dashboard pages (Providers, Usage Limits, Playground) that reveals or hides masked email addresses. Toggle state is stored in localStorage and synced globally via Zustand store - **Documentation Refresh:** Updated README, ARCHITECTURE, FEATURES, AGENTS.md, and API_REFERENCE for v3.6.2 with accurate provider counts (100+), new executor list, and system API documentation -- **Uninstall Guide:** Created comprehensive `docs/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) +- **Uninstall Guide:** Created comprehensive `docs/guides/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) ### 🐛 Bug Fixes diff --git a/docs/i18n/vi/CONTRIBUTING.md b/docs/i18n/vi/CONTRIBUTING.md index 900af1478e..bcfc476f46 100644 --- a/docs/i18n/vi/CONTRIBUTING.md +++ b/docs/i18n/vi/CONTRIBUTING.md @@ -153,7 +153,7 @@ Coverage notes: - If a PR changes production code in `src/`, `open-sse/`, `electron/`, or `bin/`, it must add or update automated tests in the same PR - `npm run coverage:report` prints the detailed file-by-file report from the latest coverage run - `npm run test:coverage:legacy` preserves the older metric for historical comparison -- See `docs/COVERAGE_PLAN.md` for the phased coverage improvement roadmap +- See `docs/ops/COVERAGE_PLAN.md` for the phased coverage improvement roadmap ### Pull Request Requirements @@ -305,7 +305,7 @@ Releases are managed via the `/generate-release` workflow. When a new GitHub Rel ## Getting Help -- **Architecture**: See [`docs/ARCHITECTURE.md`](docs/ARCHITECTURE.md) -- **API Reference**: See [`docs/API_REFERENCE.md`](docs/API_REFERENCE.md) +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](docs/architecture/ARCHITECTURE.md) +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](docs/reference/API_REFERENCE.md) - **Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) - **ADRs**: See `docs/adr/` for architectural decision records diff --git a/docs/i18n/vi/README.md b/docs/i18n/vi/README.md index 430c018158..01a5942e79 100644 --- a/docs/i18n/vi/README.md +++ b/docs/i18n/vi/README.md @@ -2267,25 +2267,25 @@ Se não quiser criar credenciais próprias agora, ainda é possível usar o flux ## Tài liệu -| Document | Description | -| -------------------------------------------------------- | --------------------------------------------------- | -| [User Guide](docs/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | -| [API Reference](docs/API_REFERENCE.md) | All endpoints with examples | -| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | -| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | -| [Auto-Combo Engine](docs/AUTO-COMBO.md) | 6-factor scoring, mode packs, self-healing | -| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | -| [Troubleshooting](docs/TROUBLESHOOTING.md) | Common problems and solutions | -| [Architecture](docs/ARCHITECTURE.md) | System architecture and internals | -| [Codebase Documentation](docs/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | -| [Uninstall Guide](docs/UNINSTALL.md) | Clean removal for all install methods | -| [Environment Config](docs/ENVIRONMENT.md) | Complete `.env` variables and references | -| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | -| [OpenAPI Spec](docs/openapi.yaml) | OpenAPI 3.0 specification | -| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | -| [VM Deployment](docs/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | -| [Features Gallery](docs/FEATURES.md) | Visual dashboard tour with screenshots | -| [Release Checklist](docs/RELEASE_CHECKLIST.md) | Pre-release validation steps | +| Document | Description | +| --------------------------------------------------------------------- | --------------------------------------------------- | +| [User Guide](docs/guides/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | +| [API Reference](docs/reference/API_REFERENCE.md) | All endpoints with examples | +| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | +| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | +| [Auto-Combo Engine](docs/routing/AUTO-COMBO.md) | 6-factor scoring, mode packs, self-healing | +| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | +| [Troubleshooting](docs/guides/TROUBLESHOOTING.md) | Common problems and solutions | +| [Architecture](docs/architecture/ARCHITECTURE.md) | System architecture and internals | +| [Codebase Documentation](docs/architecture/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | +| [Uninstall Guide](docs/guides/UNINSTALL.md) | Clean removal for all install methods | +| [Environment Config](docs/reference/ENVIRONMENT.md) | Complete `.env` variables and references | +| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | +| [OpenAPI Spec](docs/reference/openapi.yaml) | OpenAPI 3.0 specification | +| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | +| [VM Deployment](docs/ops/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | +| [Features Gallery](docs/guides/FEATURES.md) | Visual dashboard tour with screenshots | +| [Release Checklist](docs/ops/RELEASE_CHECKLIST.md) | Pre-release validation steps | --- diff --git a/docs/i18n/vi/docs/ARCHITECTURE.md b/docs/i18n/vi/docs/architecture/ARCHITECTURE.md similarity index 100% rename from docs/i18n/vi/docs/ARCHITECTURE.md rename to docs/i18n/vi/docs/architecture/ARCHITECTURE.md diff --git a/docs/i18n/vi/docs/CODEBASE_DOCUMENTATION.md b/docs/i18n/vi/docs/architecture/CODEBASE_DOCUMENTATION.md similarity index 100% rename from docs/i18n/vi/docs/CODEBASE_DOCUMENTATION.md rename to docs/i18n/vi/docs/architecture/CODEBASE_DOCUMENTATION.md diff --git a/docs/i18n/vi/docs/A2A-SERVER.md b/docs/i18n/vi/docs/frameworks/A2A-SERVER.md similarity index 100% rename from docs/i18n/vi/docs/A2A-SERVER.md rename to docs/i18n/vi/docs/frameworks/A2A-SERVER.md diff --git a/docs/i18n/vi/docs/MCP-SERVER.md b/docs/i18n/vi/docs/frameworks/MCP-SERVER.md similarity index 100% rename from docs/i18n/vi/docs/MCP-SERVER.md rename to docs/i18n/vi/docs/frameworks/MCP-SERVER.md diff --git a/docs/i18n/vi/docs/FEATURES.md b/docs/i18n/vi/docs/guides/FEATURES.md similarity index 100% rename from docs/i18n/vi/docs/FEATURES.md rename to docs/i18n/vi/docs/guides/FEATURES.md diff --git a/docs/i18n/vi/docs/I18N.md b/docs/i18n/vi/docs/guides/I18N.md similarity index 99% rename from docs/i18n/vi/docs/I18N.md rename to docs/i18n/vi/docs/guides/I18N.md index ba60c90883..6c5492915e 100644 --- a/docs/i18n/vi/docs/I18N.md +++ b/docs/i18n/vi/docs/guides/I18N.md @@ -420,7 +420,7 @@ The generator originally used `code: "in"` (deprecated Google Translate code) fo ### `docs/i18n/README.md` Is Auto-Generated -The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/I18N.md` (this file) for hand-written documentation that should persist. +The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/guides/I18N.md` (this file) for hand-written documentation that should persist. ### External Untranslatable Keys List diff --git a/docs/i18n/vi/docs/TROUBLESHOOTING.md b/docs/i18n/vi/docs/guides/TROUBLESHOOTING.md similarity index 98% rename from docs/i18n/vi/docs/TROUBLESHOOTING.md rename to docs/i18n/vi/docs/guides/TROUBLESHOOTING.md index 1b98324743..3bf2e68129 100644 --- a/docs/i18n/vi/docs/TROUBLESHOOTING.md +++ b/docs/i18n/vi/docs/guides/TROUBLESHOOTING.md @@ -335,7 +335,7 @@ You can ignore this section if you do not run RAG or agent pipelines behind Omni ## Still Stuck? - **GitHub Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) -- **Architecture**: See [`docs/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details -- **API Reference**: See [`docs/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints - **Health Dashboard**: Check **Dashboard → Health** for real-time system status - **Translator**: Use **Dashboard → Translator** to debug format issues diff --git a/docs/i18n/vi/docs/UNINSTALL.md b/docs/i18n/vi/docs/guides/UNINSTALL.md similarity index 100% rename from docs/i18n/vi/docs/UNINSTALL.md rename to docs/i18n/vi/docs/guides/UNINSTALL.md diff --git a/docs/i18n/vi/docs/USER_GUIDE.md b/docs/i18n/vi/docs/guides/USER_GUIDE.md similarity index 100% rename from docs/i18n/vi/docs/USER_GUIDE.md rename to docs/i18n/vi/docs/guides/USER_GUIDE.md diff --git a/docs/i18n/vi/docs/COVERAGE_PLAN.md b/docs/i18n/vi/docs/ops/COVERAGE_PLAN.md similarity index 100% rename from docs/i18n/vi/docs/COVERAGE_PLAN.md rename to docs/i18n/vi/docs/ops/COVERAGE_PLAN.md diff --git a/docs/i18n/vi/docs/FLY_IO_DEPLOYMENT_GUIDE.md b/docs/i18n/vi/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/vi/docs/FLY_IO_DEPLOYMENT_GUIDE.md rename to docs/i18n/vi/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/vi/docs/RELEASE_CHECKLIST.md b/docs/i18n/vi/docs/ops/RELEASE_CHECKLIST.md similarity index 94% rename from docs/i18n/vi/docs/RELEASE_CHECKLIST.md rename to docs/i18n/vi/docs/ops/RELEASE_CHECKLIST.md index da7adf8571..f72ba6c251 100644 --- a/docs/i18n/vi/docs/RELEASE_CHECKLIST.md +++ b/docs/i18n/vi/docs/ops/RELEASE_CHECKLIST.md @@ -16,14 +16,14 @@ Use this checklist before tagging or publishing a new OmniRoute release. ## API Docs -1. Update `docs/openapi.yaml`: +1. Update `docs/reference/openapi.yaml`: - `info.version` must equal `package.json` version. 2. Validate endpoint examples if API contracts changed. ## Runtime Docs -1. Review `docs/ARCHITECTURE.md` for storage/runtime drift. -2. Review `docs/TROUBLESHOOTING.md` for env var and operational drift. +1. Review `docs/architecture/ARCHITECTURE.md` for storage/runtime drift. +2. Review `docs/guides/TROUBLESHOOTING.md` for env var and operational drift. 3. Verify the release/runtime Node.js version still satisfies the supported secure floor: - `>=20.20.2 <21` or `>=22.22.2 <23` - `npm run check:node-runtime` diff --git a/docs/i18n/vi/docs/VM_DEPLOYMENT_GUIDE.md b/docs/i18n/vi/docs/ops/VM_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/vi/docs/VM_DEPLOYMENT_GUIDE.md rename to docs/i18n/vi/docs/ops/VM_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/vi/docs/API_REFERENCE.md b/docs/i18n/vi/docs/reference/API_REFERENCE.md similarity index 100% rename from docs/i18n/vi/docs/API_REFERENCE.md rename to docs/i18n/vi/docs/reference/API_REFERENCE.md diff --git a/docs/i18n/vi/docs/CLI-TOOLS.md b/docs/i18n/vi/docs/reference/CLI-TOOLS.md similarity index 100% rename from docs/i18n/vi/docs/CLI-TOOLS.md rename to docs/i18n/vi/docs/reference/CLI-TOOLS.md diff --git a/docs/i18n/vi/docs/ENVIRONMENT.md b/docs/i18n/vi/docs/reference/ENVIRONMENT.md similarity index 100% rename from docs/i18n/vi/docs/ENVIRONMENT.md rename to docs/i18n/vi/docs/reference/ENVIRONMENT.md diff --git a/docs/i18n/vi/docs/AUTO-COMBO.md b/docs/i18n/vi/docs/routing/AUTO-COMBO.md similarity index 100% rename from docs/i18n/vi/docs/AUTO-COMBO.md rename to docs/i18n/vi/docs/routing/AUTO-COMBO.md diff --git a/docs/i18n/vi/llm.txt b/docs/i18n/vi/llm.txt index 1d81a277ab..688a0ffcf3 100644 --- a/docs/i18n/vi/llm.txt +++ b/docs/i18n/vi/llm.txt @@ -357,11 +357,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### MCP Server (37 Tools) | Category | Tools | |------------|-------| -| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/MCP-SERVER.md` for full inventory) | +| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/frameworks/MCP-SERVER.md` for full inventory) | | Memory (3) | `memory_search`, `memory_add`, `memory_clear` | | Skills (4) | `skills_list`, `skills_enable`, `skills_execute`, `skills_executions` | -**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/MCP-SERVER.md`. +**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/frameworks/MCP-SERVER.md`. ### Provider Categories @@ -472,7 +472,7 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo 20. **Guardrails framework** in `src/lib/guardrails/` — hot-reloadable registry. Built-ins (priority-ordered): `vision-bridge` (5) → `pii-masker` (10) → `prompt-injection` (20). Fail-open model: exceptions never block traffic. Per-request opt-out via `x-omniroute-disabled-guardrails` header. -21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/AUTHZ_GUIDE.md`. +21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/architecture/AUTHZ_GUIDE.md`. 22. **Three resilience layers** are distinct (do not conflate them): - **Provider Circuit Breaker** (`src/shared/utils/circuitBreaker.ts`) — whole-provider scope. @@ -489,11 +489,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo - **MCP server expanded to 37 tools** (30 base + 3 memory + 4 skills) across ~13 scopes - **OAuth providers expanded to 14**: added Qwen, Kiro, Qoder, Gemini, Windsurf, GitLab Duo - **Coverage gate raised to 75/75/75/70** (was 60% across the board) — measured ~82% -- **Reasoning replay** (`docs/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams +- **Reasoning replay** (`docs/routing/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams - **Compliance + Evals + Webhooks** documentation introduced -- **Stealth guide** (`docs/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration -- **Tunnels guide** (`docs/TUNNELS_GUIDE.md`) — Cloudflare tunnel management -- **Electron guide** (`docs/ELECTRON_GUIDE.md`) — desktop app build + signing +- **Stealth guide** (`docs/security/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration +- **Tunnels guide** (`docs/ops/TUNNELS_GUIDE.md`) — Cloudflare tunnel management +- **Electron guide** (`docs/guides/ELECTRON_GUIDE.md`) — desktop app build + signing ## Links @@ -505,11 +505,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### Documentation Index -- **Architecture & Reference**: `docs/ARCHITECTURE.md`, `docs/CODEBASE_DOCUMENTATION.md`, `docs/REPOSITORY_MAP.md`, `docs/API_REFERENCE.md`, `docs/PROVIDER_REFERENCE.md`, `docs/openapi.yaml` -- **Operator guides**: `docs/USER_GUIDE.md`, `docs/CLI-TOOLS.md`, `docs/TROUBLESHOOTING.md`, `docs/COVERAGE_PLAN.md` -- **Protocols**: `docs/MCP-SERVER.md`, `docs/A2A-SERVER.md`, `docs/AGENT_PROTOCOLS_GUIDE.md`, `docs/CLOUD_AGENT.md` -- **Routing & resilience**: `docs/AUTO-COMBO.md`, `docs/RESILIENCE_GUIDE.md` -- **Security**: `docs/AUTHZ_GUIDE.md`, `docs/GUARDRAILS.md`, `docs/COMPLIANCE.md`, `docs/STEALTH_GUIDE.md` -- **Extensibility**: `docs/SKILLS.md`, `docs/MEMORY.md`, `docs/EVALS.md`, `docs/WEBHOOKS.md`, `docs/REASONING_REPLAY.md` -- **Platform**: `docs/ELECTRON_GUIDE.md`, `docs/TUNNELS_GUIDE.md` +- **Architecture & Reference**: `docs/architecture/ARCHITECTURE.md`, `docs/architecture/CODEBASE_DOCUMENTATION.md`, `docs/architecture/REPOSITORY_MAP.md`, `docs/reference/API_REFERENCE.md`, `docs/reference/PROVIDER_REFERENCE.md`, `docs/reference/openapi.yaml` +- **Operator guides**: `docs/guides/USER_GUIDE.md`, `docs/reference/CLI-TOOLS.md`, `docs/guides/TROUBLESHOOTING.md`, `docs/ops/COVERAGE_PLAN.md` +- **Protocols**: `docs/frameworks/MCP-SERVER.md`, `docs/frameworks/A2A-SERVER.md`, `docs/frameworks/AGENT_PROTOCOLS_GUIDE.md`, `docs/frameworks/CLOUD_AGENT.md` +- **Routing & resilience**: `docs/routing/AUTO-COMBO.md`, `docs/architecture/RESILIENCE_GUIDE.md` +- **Security**: `docs/architecture/AUTHZ_GUIDE.md`, `docs/security/GUARDRAILS.md`, `docs/security/COMPLIANCE.md`, `docs/security/STEALTH_GUIDE.md` +- **Extensibility**: `docs/frameworks/SKILLS.md`, `docs/frameworks/MEMORY.md`, `docs/frameworks/EVALS.md`, `docs/frameworks/WEBHOOKS.md`, `docs/routing/REASONING_REPLAY.md` +- **Platform**: `docs/guides/ELECTRON_GUIDE.md`, `docs/ops/TUNNELS_GUIDE.md` - **AI agents**: `CLAUDE.md`, `AGENTS.md`, `GEMINI.md` diff --git a/docs/i18n/zh-CN/CHANGELOG.md b/docs/i18n/zh-CN/CHANGELOG.md index 81c84439ad..2751b31000 100644 --- a/docs/i18n/zh-CN/CHANGELOG.md +++ b/docs/i18n/zh-CN/CHANGELOG.md @@ -1310,7 +1310,7 @@ We identified that **155 community PRs** across the entire project history (from - **33 New API Key Providers:** Massive provider expansion adding DeepInfra, Vercel AI Gateway, Lambda AI, SambaNova, nScale, OVHcloud AI, Baseten, PublicAI, Moonshot AI, Meta Llama API, v0 (Vercel), Morph, Featherless AI, FriendliAI, LlamaGate, Galadriel, Weights & Biases Inference, Volcengine, AI21 Labs, Venice.ai, Codestral, Upstage, Maritalk, Xiaomi MiMo, Inference.net, NanoGPT, Predibase, Bytez, Heroku AI, Databricks, Snowflake Cortex, and GigaChat (Sber). OmniRoute now supports **100+ providers** (4 Free + 8 OAuth + 91 API Key + Custom compatible) - **Global Email Privacy Toggle:** Added a persistent eye-icon toggle button across all dashboard pages (Providers, Usage Limits, Playground) that reveals or hides masked email addresses. Toggle state is stored in localStorage and synced globally via Zustand store - **Documentation Refresh:** Updated README, ARCHITECTURE, FEATURES, AGENTS.md, and API_REFERENCE for v3.6.2 with accurate provider counts (100+), new executor list, and system API documentation -- **Uninstall Guide:** Created comprehensive `docs/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) +- **Uninstall Guide:** Created comprehensive `docs/guides/UNINSTALL.md` covering clean uninstallation for all deployment methods (npm, Docker, Electron, source) ### 🐛 Bug Fixes diff --git a/docs/i18n/zh-CN/CONTRIBUTING.md b/docs/i18n/zh-CN/CONTRIBUTING.md index 2ee612ad35..59ed06cb8a 100644 --- a/docs/i18n/zh-CN/CONTRIBUTING.md +++ b/docs/i18n/zh-CN/CONTRIBUTING.md @@ -153,7 +153,7 @@ Coverage notes: - If a PR changes production code in `src/`, `open-sse/`, `electron/`, or `bin/`, it must add or update automated tests in the same PR - `npm run coverage:report` prints the detailed file-by-file report from the latest coverage run - `npm run test:coverage:legacy` preserves the older metric for historical comparison -- See `docs/COVERAGE_PLAN.md` for the phased coverage improvement roadmap +- See `docs/ops/COVERAGE_PLAN.md` for the phased coverage improvement roadmap ### Pull Request Requirements @@ -305,7 +305,7 @@ Releases are managed via the `/generate-release` workflow. When a new GitHub Rel ## Getting Help -- **Architecture**: See [`docs/ARCHITECTURE.md`](docs/ARCHITECTURE.md) -- **API Reference**: See [`docs/API_REFERENCE.md`](docs/API_REFERENCE.md) +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](docs/architecture/ARCHITECTURE.md) +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](docs/reference/API_REFERENCE.md) - **Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) - **ADRs**: See `docs/adr/` for architectural decision records diff --git a/docs/i18n/zh-CN/README.md b/docs/i18n/zh-CN/README.md index 246cd3bc1f..2152d28b8b 100644 --- a/docs/i18n/zh-CN/README.md +++ b/docs/i18n/zh-CN/README.md @@ -2267,25 +2267,25 @@ Se não quiser criar credenciais próprias agora, ainda é possível usar o flux ## 文档 -| Document | Description | -| -------------------------------------------------------- | --------------------------------------------------- | -| [User Guide](docs/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | -| [API Reference](docs/API_REFERENCE.md) | All endpoints with examples | -| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | -| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | -| [Auto-Combo Engine](docs/AUTO-COMBO.md) | 6-factor scoring, mode packs, self-healing | -| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | -| [Troubleshooting](docs/TROUBLESHOOTING.md) | Common problems and solutions | -| [Architecture](docs/ARCHITECTURE.md) | System architecture and internals | -| [Codebase Documentation](docs/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | -| [Uninstall Guide](docs/UNINSTALL.md) | Clean removal for all install methods | -| [Environment Config](docs/ENVIRONMENT.md) | Complete `.env` variables and references | -| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | -| [OpenAPI Spec](docs/openapi.yaml) | OpenAPI 3.0 specification | -| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | -| [VM Deployment](docs/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | -| [Features Gallery](docs/FEATURES.md) | Visual dashboard tour with screenshots | -| [Release Checklist](docs/RELEASE_CHECKLIST.md) | Pre-release validation steps | +| Document | Description | +| --------------------------------------------------------------------- | --------------------------------------------------- | +| [User Guide](docs/guides/USER_GUIDE.md) | Providers, combos, CLI integration, deployment | +| [API Reference](docs/reference/API_REFERENCE.md) | All endpoints with examples | +| [MCP Server](open-sse/mcp-server/README.md) | 25 MCP tools, IDE configs, Python/TS/Go clients | +| [A2A Server](src/lib/a2a/README.md) | JSON-RPC 2.0 protocol, skills, streaming, task mgmt | +| [Auto-Combo Engine](docs/routing/AUTO-COMBO.md) | 6-factor scoring, mode packs, self-healing | +| [Context Relay](docs/features/context-relay.md) | Session handoff strategy for account rotation | +| [Troubleshooting](docs/guides/TROUBLESHOOTING.md) | Common problems and solutions | +| [Architecture](docs/architecture/ARCHITECTURE.md) | System architecture and internals | +| [Codebase Documentation](docs/architecture/CODEBASE_DOCUMENTATION.md) | Beginner-friendly codebase walkthrough | +| [Uninstall Guide](docs/guides/UNINSTALL.md) | Clean removal for all install methods | +| [Environment Config](docs/reference/ENVIRONMENT.md) | Complete `.env` variables and references | +| [Contributing](CONTRIBUTING.md) | Development setup and guidelines | +| [OpenAPI Spec](docs/reference/openapi.yaml) | OpenAPI 3.0 specification | +| [Security Policy](SECURITY.md) | Vulnerability reporting and security practices | +| [VM Deployment](docs/ops/VM_DEPLOYMENT_GUIDE.md) | Complete guide: VM + nginx + Cloudflare setup | +| [Features Gallery](docs/guides/FEATURES.md) | Visual dashboard tour with screenshots | +| [Release Checklist](docs/ops/RELEASE_CHECKLIST.md) | Pre-release validation steps | --- diff --git a/docs/i18n/zh-CN/docs/ARCHITECTURE.md b/docs/i18n/zh-CN/docs/architecture/ARCHITECTURE.md similarity index 100% rename from docs/i18n/zh-CN/docs/ARCHITECTURE.md rename to docs/i18n/zh-CN/docs/architecture/ARCHITECTURE.md diff --git a/docs/i18n/zh-CN/docs/CODEBASE_DOCUMENTATION.md b/docs/i18n/zh-CN/docs/architecture/CODEBASE_DOCUMENTATION.md similarity index 100% rename from docs/i18n/zh-CN/docs/CODEBASE_DOCUMENTATION.md rename to docs/i18n/zh-CN/docs/architecture/CODEBASE_DOCUMENTATION.md diff --git a/docs/i18n/zh-CN/docs/A2A-SERVER.md b/docs/i18n/zh-CN/docs/frameworks/A2A-SERVER.md similarity index 100% rename from docs/i18n/zh-CN/docs/A2A-SERVER.md rename to docs/i18n/zh-CN/docs/frameworks/A2A-SERVER.md diff --git a/docs/i18n/zh-CN/docs/MCP-SERVER.md b/docs/i18n/zh-CN/docs/frameworks/MCP-SERVER.md similarity index 100% rename from docs/i18n/zh-CN/docs/MCP-SERVER.md rename to docs/i18n/zh-CN/docs/frameworks/MCP-SERVER.md diff --git a/docs/i18n/zh-CN/docs/FEATURES.md b/docs/i18n/zh-CN/docs/guides/FEATURES.md similarity index 100% rename from docs/i18n/zh-CN/docs/FEATURES.md rename to docs/i18n/zh-CN/docs/guides/FEATURES.md diff --git a/docs/i18n/zh-CN/docs/I18N.md b/docs/i18n/zh-CN/docs/guides/I18N.md similarity index 99% rename from docs/i18n/zh-CN/docs/I18N.md rename to docs/i18n/zh-CN/docs/guides/I18N.md index 955d694262..d613d8db72 100644 --- a/docs/i18n/zh-CN/docs/I18N.md +++ b/docs/i18n/zh-CN/docs/guides/I18N.md @@ -420,7 +420,7 @@ The generator originally used `code: "in"` (deprecated Google Translate code) fo ### `docs/i18n/README.md` Is Auto-Generated -The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/I18N.md` (this file) for hand-written documentation that should persist. +The `docs/i18n/README.md` file is completely regenerated by `generate-multilang.mjs docs`. Any manual edits will be lost. Use `docs/guides/I18N.md` (this file) for hand-written documentation that should persist. ### External Untranslatable Keys List diff --git a/docs/i18n/zh-CN/docs/TROUBLESHOOTING.md b/docs/i18n/zh-CN/docs/guides/TROUBLESHOOTING.md similarity index 98% rename from docs/i18n/zh-CN/docs/TROUBLESHOOTING.md rename to docs/i18n/zh-CN/docs/guides/TROUBLESHOOTING.md index dbac2c443f..40cb6e53ef 100644 --- a/docs/i18n/zh-CN/docs/TROUBLESHOOTING.md +++ b/docs/i18n/zh-CN/docs/guides/TROUBLESHOOTING.md @@ -335,7 +335,7 @@ You can ignore this section if you do not run RAG or agent pipelines behind Omni ## Still Stuck? - **GitHub Issues**: [github.com/diegosouzapw/OmniRoute/issues](https://github.com/diegosouzapw/OmniRoute/issues) -- **Architecture**: See [`docs/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details -- **API Reference**: See [`docs/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints +- **Architecture**: See [`docs/architecture/ARCHITECTURE.md`](ARCHITECTURE.md) for internal details +- **API Reference**: See [`docs/reference/API_REFERENCE.md`](API_REFERENCE.md) for all endpoints - **Health Dashboard**: Check **Dashboard → Health** for real-time system status - **Translator**: Use **Dashboard → Translator** to debug format issues diff --git a/docs/i18n/zh-CN/docs/UNINSTALL.md b/docs/i18n/zh-CN/docs/guides/UNINSTALL.md similarity index 100% rename from docs/i18n/zh-CN/docs/UNINSTALL.md rename to docs/i18n/zh-CN/docs/guides/UNINSTALL.md diff --git a/docs/i18n/zh-CN/docs/USER_GUIDE.md b/docs/i18n/zh-CN/docs/guides/USER_GUIDE.md similarity index 100% rename from docs/i18n/zh-CN/docs/USER_GUIDE.md rename to docs/i18n/zh-CN/docs/guides/USER_GUIDE.md diff --git a/docs/i18n/zh-CN/docs/COVERAGE_PLAN.md b/docs/i18n/zh-CN/docs/ops/COVERAGE_PLAN.md similarity index 100% rename from docs/i18n/zh-CN/docs/COVERAGE_PLAN.md rename to docs/i18n/zh-CN/docs/ops/COVERAGE_PLAN.md diff --git a/docs/i18n/zh-CN/docs/FLY_IO_DEPLOYMENT_GUIDE.md b/docs/i18n/zh-CN/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/zh-CN/docs/FLY_IO_DEPLOYMENT_GUIDE.md rename to docs/i18n/zh-CN/docs/ops/FLY_IO_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/zh-CN/docs/RELEASE_CHECKLIST.md b/docs/i18n/zh-CN/docs/ops/RELEASE_CHECKLIST.md similarity index 94% rename from docs/i18n/zh-CN/docs/RELEASE_CHECKLIST.md rename to docs/i18n/zh-CN/docs/ops/RELEASE_CHECKLIST.md index 218b7a6fc2..5f60e67283 100644 --- a/docs/i18n/zh-CN/docs/RELEASE_CHECKLIST.md +++ b/docs/i18n/zh-CN/docs/ops/RELEASE_CHECKLIST.md @@ -16,14 +16,14 @@ Use this checklist before tagging or publishing a new OmniRoute release. ## API Docs -1. Update `docs/openapi.yaml`: +1. Update `docs/reference/openapi.yaml`: - `info.version` must equal `package.json` version. 2. Validate endpoint examples if API contracts changed. ## Runtime Docs -1. Review `docs/ARCHITECTURE.md` for storage/runtime drift. -2. Review `docs/TROUBLESHOOTING.md` for env var and operational drift. +1. Review `docs/architecture/ARCHITECTURE.md` for storage/runtime drift. +2. Review `docs/guides/TROUBLESHOOTING.md` for env var and operational drift. 3. Verify the release/runtime Node.js version still satisfies the supported secure floor: - `>=20.20.2 <21` or `>=22.22.2 <23` - `npm run check:node-runtime` diff --git a/docs/i18n/zh-CN/docs/VM_DEPLOYMENT_GUIDE.md b/docs/i18n/zh-CN/docs/ops/VM_DEPLOYMENT_GUIDE.md similarity index 100% rename from docs/i18n/zh-CN/docs/VM_DEPLOYMENT_GUIDE.md rename to docs/i18n/zh-CN/docs/ops/VM_DEPLOYMENT_GUIDE.md diff --git a/docs/i18n/zh-CN/docs/API_REFERENCE.md b/docs/i18n/zh-CN/docs/reference/API_REFERENCE.md similarity index 100% rename from docs/i18n/zh-CN/docs/API_REFERENCE.md rename to docs/i18n/zh-CN/docs/reference/API_REFERENCE.md diff --git a/docs/i18n/zh-CN/docs/CLI-TOOLS.md b/docs/i18n/zh-CN/docs/reference/CLI-TOOLS.md similarity index 100% rename from docs/i18n/zh-CN/docs/CLI-TOOLS.md rename to docs/i18n/zh-CN/docs/reference/CLI-TOOLS.md diff --git a/docs/i18n/zh-CN/docs/ENVIRONMENT.md b/docs/i18n/zh-CN/docs/reference/ENVIRONMENT.md similarity index 100% rename from docs/i18n/zh-CN/docs/ENVIRONMENT.md rename to docs/i18n/zh-CN/docs/reference/ENVIRONMENT.md diff --git a/docs/i18n/zh-CN/docs/AUTO-COMBO.md b/docs/i18n/zh-CN/docs/routing/AUTO-COMBO.md similarity index 100% rename from docs/i18n/zh-CN/docs/AUTO-COMBO.md rename to docs/i18n/zh-CN/docs/routing/AUTO-COMBO.md diff --git a/docs/i18n/zh-CN/llm.txt b/docs/i18n/zh-CN/llm.txt index 8dd20af3fc..e834391ef4 100644 --- a/docs/i18n/zh-CN/llm.txt +++ b/docs/i18n/zh-CN/llm.txt @@ -357,11 +357,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### MCP Server (37 Tools) | Category | Tools | |------------|-------| -| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/MCP-SERVER.md` for full inventory) | +| Core (30) | `get_health`, `list_combos`, `get_combo_metrics`, `switch_combo`, `check_quota`, `route_request`, `cost_report`, `list_models_catalog`, `web_search`, `simulate_route`, `set_budget_guard`, `set_routing_strategy`, `set_resilience_profile`, `test_combo`, `get_provider_metrics`, `best_combo_for_task`, `explain_route`, `get_session_snapshot`, `db_health_check`, `sync_pricing`, `cache_stats`, `cache_flush`, and advanced routing/diagnostics tools (see `docs/frameworks/MCP-SERVER.md` for full inventory) | | Memory (3) | `memory_search`, `memory_add`, `memory_clear` | | Skills (4) | `skills_list`, `skills_enable`, `skills_execute`, `skills_executions` | -**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/MCP-SERVER.md`. +**MCP Auth Scopes (~13):** `read:health`, `read:combos`, `write:combos`, `read:quota`, `read:usage`, `read:models`, `execute:completions`, `execute:search`, `write:budget`, `write:resilience`, plus memory/skills scopes — full list in `docs/frameworks/MCP-SERVER.md`. ### Provider Categories @@ -472,7 +472,7 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo 20. **Guardrails framework** in `src/lib/guardrails/` — hot-reloadable registry. Built-ins (priority-ordered): `vision-bridge` (5) → `pii-masker` (10) → `prompt-injection` (20). Fail-open model: exceptions never block traffic. Per-request opt-out via `x-omniroute-disabled-guardrails` header. -21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/AUTHZ_GUIDE.md`. +21. **Authz pipeline** (`src/server/authz/`): every request is classified as `PUBLIC`, `CLIENT_API`, or `MANAGEMENT`, then run through policy + enforce stages. See `docs/architecture/AUTHZ_GUIDE.md`. 22. **Three resilience layers** are distinct (do not conflate them): - **Provider Circuit Breaker** (`src/shared/utils/circuitBreaker.ts`) — whole-provider scope. @@ -489,11 +489,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo - **MCP server expanded to 37 tools** (30 base + 3 memory + 4 skills) across ~13 scopes - **OAuth providers expanded to 14**: added Qwen, Kiro, Qoder, Gemini, Windsurf, GitLab Duo - **Coverage gate raised to 75/75/75/70** (was 60% across the board) — measured ~82% -- **Reasoning replay** (`docs/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams +- **Reasoning replay** (`docs/routing/REASONING_REPLAY.md`) — capture and inspect provider reasoning streams - **Compliance + Evals + Webhooks** documentation introduced -- **Stealth guide** (`docs/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration -- **Tunnels guide** (`docs/TUNNELS_GUIDE.md`) — Cloudflare tunnel management -- **Electron guide** (`docs/ELECTRON_GUIDE.md`) — desktop app build + signing +- **Stealth guide** (`docs/security/STEALTH_GUIDE.md`) — TLS / CLI fingerprint configuration +- **Tunnels guide** (`docs/ops/TUNNELS_GUIDE.md`) — Cloudflare tunnel management +- **Electron guide** (`docs/guides/ELECTRON_GUIDE.md`) — desktop app build + signing ## Links @@ -505,11 +505,11 @@ OmniRoute solves the problem of managing multiple AI provider subscriptions, quo ### Documentation Index -- **Architecture & Reference**: `docs/ARCHITECTURE.md`, `docs/CODEBASE_DOCUMENTATION.md`, `docs/REPOSITORY_MAP.md`, `docs/API_REFERENCE.md`, `docs/PROVIDER_REFERENCE.md`, `docs/openapi.yaml` -- **Operator guides**: `docs/USER_GUIDE.md`, `docs/CLI-TOOLS.md`, `docs/TROUBLESHOOTING.md`, `docs/COVERAGE_PLAN.md` -- **Protocols**: `docs/MCP-SERVER.md`, `docs/A2A-SERVER.md`, `docs/AGENT_PROTOCOLS_GUIDE.md`, `docs/CLOUD_AGENT.md` -- **Routing & resilience**: `docs/AUTO-COMBO.md`, `docs/RESILIENCE_GUIDE.md` -- **Security**: `docs/AUTHZ_GUIDE.md`, `docs/GUARDRAILS.md`, `docs/COMPLIANCE.md`, `docs/STEALTH_GUIDE.md` -- **Extensibility**: `docs/SKILLS.md`, `docs/MEMORY.md`, `docs/EVALS.md`, `docs/WEBHOOKS.md`, `docs/REASONING_REPLAY.md` -- **Platform**: `docs/ELECTRON_GUIDE.md`, `docs/TUNNELS_GUIDE.md` +- **Architecture & Reference**: `docs/architecture/ARCHITECTURE.md`, `docs/architecture/CODEBASE_DOCUMENTATION.md`, `docs/architecture/REPOSITORY_MAP.md`, `docs/reference/API_REFERENCE.md`, `docs/reference/PROVIDER_REFERENCE.md`, `docs/reference/openapi.yaml` +- **Operator guides**: `docs/guides/USER_GUIDE.md`, `docs/reference/CLI-TOOLS.md`, `docs/guides/TROUBLESHOOTING.md`, `docs/ops/COVERAGE_PLAN.md` +- **Protocols**: `docs/frameworks/MCP-SERVER.md`, `docs/frameworks/A2A-SERVER.md`, `docs/frameworks/AGENT_PROTOCOLS_GUIDE.md`, `docs/frameworks/CLOUD_AGENT.md` +- **Routing & resilience**: `docs/routing/AUTO-COMBO.md`, `docs/architecture/RESILIENCE_GUIDE.md` +- **Security**: `docs/architecture/AUTHZ_GUIDE.md`, `docs/security/GUARDRAILS.md`, `docs/security/COMPLIANCE.md`, `docs/security/STEALTH_GUIDE.md` +- **Extensibility**: `docs/frameworks/SKILLS.md`, `docs/frameworks/MEMORY.md`, `docs/frameworks/EVALS.md`, `docs/frameworks/WEBHOOKS.md`, `docs/routing/REASONING_REPLAY.md` +- **Platform**: `docs/guides/ELECTRON_GUIDE.md`, `docs/ops/TUNNELS_GUIDE.md` - **AI agents**: `CLAUDE.md`, `AGENTS.md`, `GEMINI.md`