Skip to content

Replace "Your workspace" with actual console navigation #1186

Closed

Description

@tgrunnagle

Part of #1175.

Problem

The docs send users to Your workspace, and that label doesn't exist in the console. Users switch Experience to User in the account menu. The User experience has Home, plus Connectors and AI Gateway under Gateways. The Connectors area has three tabs: Tools, Usage, and Clients.

Pages that reference Your workspace, or its Setup area:

  • docs/connector-gateway/connectors.mdx:54
  • docs/platform/enterprise-platform/roll-out-gateway-clients.mdx:20,40. The page's Setup is actually the Clients tab under Connectors.
  • docs/platform/enterprise-directory/virtual-api-keys.mdx:16 (API keys in Your workspace)
  • docs/platform/enterprise-directory/index.mdx:52
  • docs/platform/enterprise-console/index.mdx:18 ("switch between Administration and Your workspace")

Recommendations

  • Replace every reference with the console's actual navigation. Check the AI Gateway user area and the API keys location in the console while doing this.

  • Document the Connectors Clients tab in roll-out-gateway-clients.mdx. It covers:

    • the endpoint and transport (Streamable HTTP, OAuth with dynamic client registration)
    • the Ask your AI assistant prompt
    • setup guides for Claude Code, Claude (web and desktop), Codex, Cursor, VS Code, and other clients

    Note that Claude on the web or desktop needs the gateway to be reachable from the public internet.

  • Use the user-side status labels Connected, Paused, and Reconnect required, and the actions Connect, Reconnect, Pause/Resume, and Disconnect. The end-user page in Connector Gateway: add quickstart, user, telemetry, troubleshooting #1179 depends on this.

  • Consider a word-list entry in STYLE-GUIDE.md for the console's two experiences, Administration and User

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't workingdocumentationImprovements or additions to documentationneeds-triageIssue needs initial triage by a maintainer

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions