Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Replace "Your workspace" with actual console navigation

Đã đóng
  • Có gì không ổn?
#1,186 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Một pull request liên quan đã được merge.

  • #1208 của @tgrunnagle — đã merge

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
68/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Lĩnh vực
documentation

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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

Ngôn ngữ chính
JavaScript
Star
4
Fork
4
Merge trung bình
1 ngày 1 giờ
Pull request đã merge (30 ngày)
58

Chuẩn bị môi trường

Mở trong Codespaces

Khởi chạy dev container của dự án ngay trên trình duyệt, bằng tài khoản GitHub của bạn.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của stacklok/docs-website

Tất cả issue của stacklok/docs-website

Issue tương tự

Thêm issue về JavaScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.