Repository navigation
Replace "Your workspace" with console navigation - #1208
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Overall editorial and information-architecture assessment of the seven-PR stack at a9c7827.
The stack substantially improves the Connector Gateway documentation: it corrects product claims and console labels, adds a concrete quickstart, makes connector management task-based, and separates usage recording, telemetry, and audit logs. The remaining work is to make the assembled documentation a coherent set of reader journeys and address the page-level findings linked below.
Organize around administrator and owner tasks
The audience for these docs is administrators, platform owners, and people supporting their organization's internal users. Routine end-user workflows should be understandable in the app, with contextual in-app help and organization-specific guidance supplementing that experience. Internal users should not need to navigate the full administrator docs site to connect a client or manage their connections.
Document user behavior here when an administrator needs to understand, roll out, or troubleshoot it. Reframe Your connections as support guidance covering connection states, tool choices, reconnection, and administrator checks. Keep client-specific setup instructions in the app; the rollout guide should help owners prepare access, distribute the console URL, and support users. The quickstart can retain its administrator-as-user test to verify the complete flow.
I recommend organizing the canonical pages along these lines:
- Get started: Introduction and an administrator validation Quickstart.
- Configure and secure: Connectors, Managed secrets, Identity providers, Authentication, and Policies.
- Roll out and support: Rollout preparation and guidance for supporting users' connector access.
- Operate: Tool usage, Telemetry, and Audit logs.
Expose these administrator/owner starting routes early in the introduction. This replaces the earlier recommendation for a separate end-user "Use the gateway" journey.
The Managed secrets and Identity providers sidebar entries currently replace the Connector Gateway sidebar with Platform navigation. I reproduced this in the preview. These pages principally describe connector credentials, and the console also groups them under Connectors. Place their canonical guides in this product section, update Platform cross-links and redirects, and retain corporate platform sign-in configuration under Platform. Avoid creating duplicate guides to populate both sections. The specific sidebar finding is on #1205; this is the corresponding ownership decision for the assembled result.
Findings on the owning PRs
- #1201 review: earlier editorial assessment stands; API spec match verified; no additional editorial finding specific to this PR.
- #1202 review: distinguish console-supported authentication from API-only types and make policy management actionable.
- #1204 review: reframe connection guidance for administrators supporting internal users and remove the quickstart's assumption that DeepWiki becomes the busiest connector.
- #1205 review: fix sidebar context switches, route readers earlier, and qualify the structured/Cedar group-model statement.
- #1206 review: consolidate grant/revoke instructions in the dedicated policy guide, coordinating with #1202.
- #1207 review: qualify top-100 totals and shares, and remove the inference that an absent connector has zero usage.
Please resolve those findings on their owning PRs and reassess the combined navigation after the fixes propagate through the stack.
Validation boundaries
This assessment includes the final Connector Gateway pages, the cumulative diff, related Platform content, preview navigation, and targeted upstream source checks. It does not establish live validation of the quickstart, Helm deployment, or log-shipping examples.
At the reviewed head, lint/format checks and Vercel deployment pass, but the visual regression run fails on the Connector Gateway navigation snapshot. Review and settle the final navigation before refreshing that baseline.
danbarr
left a comment
There was a problem hiding this comment.
Blocking on the capitalization guidance added to AGENTS.md and STYLE-GUIDE.md. "Administration experience" and "User experience" are generic descriptions, so running prose should use lowercase under our existing capitalization rules. Preserve exact capitalization and bold formatting when referring to the selectable UI labels Administration, User, and Experience. Inline suggestions update both guidance entries; please also lowercase the running-prose occurrences introduced by this PR. The other editorial and organizational findings remain in the earlier comment reviews.
danbarr
left a comment
There was a problem hiding this comment.
Adding the corresponding prose suggestions for the capitalization issue in my request-changes review. These five changes keep generic experience descriptions lowercase while preserving exact, bolded UI labels in selection instructions.
a9c7827 to
524dbf9
Compare
Visual regression failedCommit
Open the failed visual job · Download the full Playwright report If the change is intentional, a repository collaborator can comment |
Refocus the rollout guide on preparing access, pointing users to the console, and supporting them, leaving client setup to the console. Group the Connector Gateway sidebar into configure, roll out, and operate sections, and replace the intro's card list with next steps. Addresses #1208 review: - body (5419974618): organize pages around administrator and owner tasks - body (5419974618): keep client-specific setup instructions in the app Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
524dbf9 to
8f2998b
Compare
|
Addressed in 8f2998b, with the page-level findings fixed on their owning PRs (links in each PR's reply). The rollout guide now covers preparing access, network reachability, pointing users to the console, and supporting them; client-specific setup stays in the console. The Connector Gateway sidebar is grouped into Configure and secure, Roll out and support, and Operate. The rollout guide stays under Platform because it covers both gateways, and the intro links to it. I haven't refreshed the visual baseline, so it can be refreshed once the navigation is settled. |
Addresses #1208 review: - AGENTS.md (4188363988): lowercase generic experience descriptions - STYLE-GUIDE.md (4188364011): keep exact labels only in UI instructions Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Point users to the User experience, the Gateways nav, and the Clients and API Keys tabs. Document the Connectors Clients tab on the rollout page, and add a word-list entry for the two console experiences. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Refocus the rollout guide on preparing access, pointing users to the console, and supporting them, leaving client setup to the console. Group the Connector Gateway sidebar into configure, roll out, and operate sections, and replace the intro's card list with next steps. Addresses #1208 review: - body (5419974618): organize pages around administrator and owner tasks - body (5419974618): keep client-specific setup instructions in the app Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Addresses #1208 review: - AGENTS.md (4188363988): lowercase generic experience descriptions - STYLE-GUIDE.md (4188364011): keep exact labels only in UI instructions Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
aced367 to
1f956aa
Compare
|
/update-snapshots |
|
📸 Regenerated visual baselines per your |
danbarr
left a comment
There was a problem hiding this comment.
Approved from an editorial and information-architecture perspective. The findings from the stack review are addressed in the assembled result: administrator/owner audience, coherent navigation and credential-guide ownership, canonical access instructions, explicit API-only authentication, qualified usage reporting, and lowercase experience descriptions in prose. This approval does not assert live end-to-end validation of the deployment or examples.
Description
Replaces references to Your workspace, which isn't a console label, with the console's actual navigation, per #1186. Stacked on #1207; retarget to
mainafter it merges.Some items in the issue were already handled by earlier PRs:
connectors.mdxandenterprise-console/index.mdxno longer mention Your workspace, andmanage-connections.mdx(#1179) already uses the Connected, Paused, and Reconnect required statuses and the Connect, Reconnect, Pause/Resume, and Disconnect actions. This PR covers the rest:roll-out-gateway-clients.mdx: replaces "Setup in each gateway area of Your workspace" with the path to each gateway's Clients tab. Adds a Connector Gateway section covering Ask your AI assistant, Manual setup (Streamable HTTP, OAuth with dynamic client registration), and the setup guides (Claude Code, Claude web and desktop, Codex, Cursor, VS Code, Other clients). It notes that Claude on the web and desktop needs a publicly reachable gateway. A short AI Gateway section covers that tab's Model gateway URL, Get an API key, and setup guides.virtual-api-keys.mdxandenterprise-directory/index.mdx: point to the API Keys tab under AI Gateway in the User experience.quickstart.mdxandmanage-connections.mdx: capitalize "User experience" to match the label and the existing "Administration experience".STYLE-GUIDE.mdandAGENTS.md: word-list guidance for the Administration and User experiences.Verification
Checked in
stacklok-enterprise-platformat790e45643, underenterprise/toolhive-cloud-ui/src/:components/console/user-nav.tscomponents/console/nav-visibility.tsfeatures/connector-gateway/components/setup-page.tsx,features/connector-gateway/lib/client-setup-guides.tsfeatures/gateway-setup/components/gateway-setup-page.tsxnpm run buildpasses, and Prettier and ESLint are clean. The build's one SSG warning is on the existing API reference page.Type of change
Related issues/PRs
Closes #1186. Part of #1175. Stacked on #1207.
Submitter checklist
Content and formatting
Navigation
sidebars.ts) updated for added, deleted, reordered, or renamed files (no changes needed)vercel.jsonfor moved, renamed, or deleted pages (no URLs changed)Reviewer checklist
Content
🤖 Generated with Claude Code