Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Replace "Your workspace" with actual console navigation

Chiusa
  • Qualcosa non va?
#1,186 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Una pull request collegata è già stata integrata.

  • #1208 di @tgrunnagle — integrata

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
68/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Ambito
documentation

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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

Lingua principale
TypeScript
Stelle
4
Fork
4
Merge medio
1g 17m
PR unite (30g)
63

Preparare l'ambiente

Apri in Codespaces

Avvia il container di sviluppo del progetto nel browser, con il tuo account GitHub.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di stacklok/docs-website

Tutte le issue di stacklok/docs-website

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.