Add Cloud UI documentation section#889
Conversation
Closes #870. Adds a new Cloud UI section under Platform capabilities with an introduction, Docker Compose quickstart, and configuration guide covering environment variables, OIDC setup, and deployment options (Docker, Compose, Helm). Adds cross-reference from the Registry Server index page. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Pull request overview
Adds end-user documentation for the ToolHive Cloud UI and wires it into the Docusaurus navigation so readers can discover, deploy, and configure the web catalog experience backed by the Registry Server.
Changes:
- Adds a new Cloud UI docs section (landing page, Docker Compose quickstart, and configuration/deployment guide).
- Updates the sidebar to include the new Cloud UI category under Platform capabilities.
- Adds a cross-reference tip from the Registry Server docs to the Cloud UI section.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
sidebars.ts |
Adds a new “Cloud UI” category under Platform capabilities in the docs sidebar. |
docs/toolhive/guides-registry/index.mdx |
Adds a tip linking Registry Server readers to the Cloud UI docs. |
docs/toolhive/guides-cloud-ui/index.mdx |
Introduces a new Cloud UI section landing page with architecture/where-to-start and DocCardList. |
docs/toolhive/guides-cloud-ui/quickstart.mdx |
Adds a Docker Compose-based quickstart tutorial for running Cloud UI + Registry Server locally. |
docs/toolhive/guides-cloud-ui/configuration.mdx |
Documents env vars, OIDC setup, and Docker/Compose/Helm deployment options. |
Replace the Docker Compose quickstart with a Kubernetes deployment how-to guide that builds on the Registry Server quickstart as a prerequisite and walks through OIDC setup, per Dan's review feedback. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Editorial pass on the Cloud UI section while the author is out: - Reframe deployment guide as a how-to rather than a tutorial: drop "What you'll learn", rewrite the intro, and retitle the explanatory aside. Expand IdP on first use and link the CLOUD_UI_URL/BETTER_AUTH_URL placeholders together. - Surface the section from the home page: add a platform-overview bullet and point the Portal architecture and key-features links at the docs instead of the repo. - Add "Deploy the Cloud UI" links from the Registry Server quickstart and publish-servers Next steps. - Drop the "experimental" framing and correct the Cloud UI description in the contributing guide to a read-only view over a Registry Server catalog. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Second editorial pass on the Cloud UI section: - Install the Helm chart directly from GHCR (oci://ghcr.io/stacklok/toolhive-cloud-ui/toolhive-cloud-ui) and drop the git clone step and Git prerequisite. Renumber the steps. - Replace the intro ASCII architecture diagram with Mermaid. - Rework the expose step: lead with the standard ClusterIP Service working with any Ingress/Gateway API/LoadBalancer, switch the Ingress example from deprecated nginx to Traefik, and link the Connect clients guide for the Gateway API path. - Rename "Clean up" to "Uninstall the Cloud UI" and correct the sign-in flow (welcome page with a Sign in button, then the IdP). - Replace the hand-wavy chart-values list with a values table and defaults, and state that app settings are passed only as env vars (no first-class Helm values), verified against the chart. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
Picking up this PR while @peppescg is out. Summary of the editorial and accuracy changes layered on top of the original commits, across follow-up commits Diataxis: tutorial → how-to. The deployment guide still read like its original quickstart form, so I reframed it: removed the "What you'll learn" section, rewrote the intro, retitled the explanatory "What's happening?" aside, renamed "Clean up" to "Uninstall the Cloud UI," and corrected the sign-in flow (you land on a welcome page and select Sign in, then get redirected to the IdP, rather than being redirected immediately). Simplified install. Dropped the Exposing the UI. Replaced the deprecated Config reference accuracy. Verified against the chart's Section structure (Copilot feedback). Split the landing page into a thin Discoverability. The section was reachable only from the sidebar. Added inbound links: a platform-overview bullet and updated Portal references on the docs home page (pointing at the docs instead of the repo), plus "Deploy the Cloud UI" links from the Registry Server quickstart and publish-servers guides. Enterprise upsell. Added an Other. Replaced the intro ASCII architecture diagram with Mermaid. Corrected the Cloud UI framing in the contributing guide (read-only view over a Registry Server catalog, dropped "experimental"). Updated the PR description to use the repo template. One thing left to confirm: the technical accuracy checkbox, since I verified the chart/OCI/values mechanics but not every OIDC provider claim end to end. |
Address Copilot review feedback on sidebar structure: - Split the section landing page into a thin index.mdx (intro blurb, where-to-start, DocCardList) and a dedicated intro.mdx Introduction page, matching the Registry Server, vMCP, and K8s sections. List intro as the explicit first sidebar child. - Reword the sidebar description from "browse and manage" to "browse and discover" to match the read-only framing used throughout the section. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Point readers from the OSS read-only catalog to the enhanced Enterprise Cloud UI, which adds skill browsing and installation and registry source and entry management. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Add a light/dark catalog screenshot to the Introduction page so readers can see the browsable interface before deploying it. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…website into docs/cloud-ui-870
Without fullnameOverride, the chart names resources <release>-<chart> (cloud-ui-toolhive-cloud-ui), so the deployment/cloud-ui, svc/cloud-ui, and ingress backendRef references throughout the guide would point at nonexistent resources. Add --set fullnameOverride=cloud-ui to the install and explain why it's there. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Description
Adds a new Cloud UI section documenting the ToolHive Cloud UI: a read-only, web-based catalog frontend for the Registry Server with OIDC authentication.
The section includes:
It also improves discoverability of the new section:
Type of change
Related issues/PRs
Closes #870
Screenshots
Submitter checklist
Content and formatting
Navigation
sidebars.ts) updated for added, deleted, reordered, or renamed filesvercel.jsonfor moved, renamed, or deleted pages (i.e., if the URL slug changed)Reviewer checklist
Content