docs: document web-UI harness credential setup - #392
Open
omnigent-ci[bot] wants to merge 4 commits into
Open
Conversation
Co-authored-by: omnigent-ci[bot] <294685417+omnigent-ci[bot]@users.noreply.github.com>
Co-authored-by: omnigent-ci[bot] <294685417+omnigent-ci[bot]@users.noreply.github.com>
) * docs(build): add Smart Routing page with external routing API spec Document the smart-routing feature as a standalone page under Build: - enabling it via OMNIGENT_SMART_ROUTING=1 (built-in judge vs external API) - the top-level routing: server config block (base_url, router_name, model_prefix, api_key/profile auth precedence) - the external routes:select API spec (SelectRouteRequest / SelectRouteResponse from omnigent.api.routing.v1) with request/response field tables and JSON examples Registered in the sidebar and prev/next nav under Custom Agents, and regenerated the OG manifest. * docs(routing): smart routing enables from config, no OMNIGENT_SMART_ROUTING The server no longer gates routing behind an opt-in env; it builds the routing client whenever an llm: block (built-in judge) or a routing.provider=external block is configured. Update the enablement section accordingly. Signed-off-by: Tomu Hirata <tomu.hirata@databricks.com> * docs(routing): regenerate og-manifest for 0.7-docs pages Regenerate lib/og-manifest.json from the pages actually present on the 0.7-docs branch, so the routing entry is added without dragging in main-only manifest copy (the cherry-pick had carried main's mobile description). Signed-off-by: Tomu Hirata <tomu.hirata@databricks.com> * docs(routing): drop '(default)' label from built-in judge Neither router is a default — routing is chosen by which config block is present (llm: → built-in judge, routing.provider=external → external API). Signed-off-by: Tomu Hirata <tomu.hirata@databricks.com> * docs(routing): add demo video and fix server start command - Embed a Smart Routing demo (public/images/docs/smart-routing-oss.mp4) via a <video> tag in the routing page. - Fix the enablement command: 'omni server -c path/to/config.yaml' (the server subcommand + explicit config path), not 'omni serve'. Signed-off-by: Tomu Hirata <tomu.hirata@databricks.com> * docs(routing): size demo video via inline style like site images className=w-full (Tailwind) on a raw MDX element wasn't in the compiled CSS, so the video rendered at its intrinsic (oversized) resolution. Use the same inline style the site's img mapper applies (width:100%, height:auto, rounded) so the video scales to the content column like the GIF demos. Signed-off-by: Tomu Hirata <tomu.hirata@databricks.com> * docs(routing): move demo video up under the intro Place the demo right after the opening paragraph (before 'Two routers are available') so readers see it before the configuration details. Signed-off-by: Tomu Hirata <tomu.hirata@databricks.com> * docs(routing): replace em dashes with commas/colons Drop em dashes throughout the routing page in favor of commas or colons for a plainer style. Signed-off-by: Tomu Hirata <tomu.hirata@databricks.com> * docs(routing): drop redundant 'no feature flag' sentence The enablement section already explains that routing turns on from config (an llm: block or a routing: block), so the standalone sentence was redundant. Signed-off-by: Tomu Hirata <tomu.hirata@databricks.com> --------- Signed-off-by: Tomu Hirata <tomu.hirata@databricks.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
omnigent-ci
Bot
added
automated-docs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documentation update for omnigent-ai/omnigent#3088 — feat(onboarding): write a harness provider credential from the UI (M3 backend)
Changes documented
app/docs/build/models/page.mdx— added a "From the web UI" subsection under Credentials describing the setup dialog's Add a credential action: the three kinds (API key / gateway / adopt), where the secret is stored on the host (OS keychain →~/.omnigent/secrets.json), theproviders:reference-not-raw-value behavior, the server-as-pass-through security note, the Claude/Codex/Pi vs. env-auth (OpenCode/Qwen) scope, in-place readiness refresh, and theOMNIGENT_HARNESS_INSTALL_ENABLEDgate.Manual review needed
app/docs/build/models/page.mdx— no screenshot/GIF exists for the new web-UI credential dialog; consider adding one (I cannot generate binaries).app/reference(REST API) — two new endpoints (POST /v1/hosts/{host_id}/harnesses/{harness}/credentialandGET /v1/hosts/{host_id}/credentials/detected) landed inopenapi.json. If the reference page is generated from that spec no action is needed; if it's hand-maintained, add these routes.app/docs/interact/web-ui/page.mdx.Source PR: omnigent-ai/omnigent#3088 · merged by @xq-yin
Drafted automatically by the doc-sync workflow. Review for accuracy before merging.