Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Replace "Your workspace" with actual console navigation

Open
  • Is something wrong?
#1,186 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
68/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Active
Domain
documentation

Research direction

Review the listed pages in docs/connector-gateway/connectors.mdx, docs/platform/enterprise-platform/roll-out-gateway-clients.mdx, docs/platform/enterprise-directory/virtual-api-keys.mdx, docs/platform/enterprise-directory/index.mdx, and docs/platform/enterprise-console/index.mdx, along with STYLE-GUIDE.md. First verify the current console navigation and labels, then update the references and document the Connectors Clients tab and supported client setup guidance. Done means no stale “Your workspace” or “Setup” references remain and the requested status and action labels are consistent.

Written by the indexing model from the issue text.

Description

bug documentation needs-triage

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 #1179 depends on this.

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

Dominant language
TypeScript
Stars
4
Forks
3
Avg merge
22h
Merged PRs (30d)
37

Getting set up

Open in Codespaces

Starts the project's dev container in your browser, under your own GitHub account.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from stacklok/docs-website

All issues in stacklok/docs-website

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.