Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Replace "Your workspace" with actual console navigation

Cerrado
  • ¿Algo no está bien?
#1,186 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Ya se ha fusionado un pull request relacionado.

  • #1208 de @tgrunnagle — fusionado

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
68/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Activo
Área
documentation

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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

Lenguaje dominante
JavaScript
Estrellas
4
Forks
4
Merge medio
1 d 1 h
PR fusionados (30 d)
58

Preparar el entorno

Abrir en Codespaces

Inicia el contenedor de desarrollo del proyecto en tu navegador, con tu propia cuenta de GitHub.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de stacklok/docs-website

Todos los issues de stacklok/docs-website

Issues similares

Más issues de JavaScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.