docs: replace legacy console / port 8020 refs with Web Studio (/studio)#2175
Merged
qin-ctx merged 1 commit intoMay 21, 2026
Merged
Conversation
…/studio) Follow-up to volcengine#2160 (console removal) and volcengine#2170 (OAuth UI moved to web-studio). Six guides still showed the old `python -m openviking.console.bootstrap` launch + `-p 8020:8020` docker run snippets, which now fail because the console package is gone and the image no longer exposes 8020. - docs/{en,zh}/getting-started/04-setup-for-agent.md: drop `-p 8020:8020` from docker run and the "ports: 1933:1933, 8020:8020" summary; note that Web Studio is served by the OV server at `/studio` so no extra port is needed. - docs/{en,zh}/guides/03-deployment.md: drop 4× `-p 8020:8020` snippets, replace "OpenViking Console on port 8020" with the inline `/studio` mention, and update the "access this after startup" list to point at `http://localhost:1933/studio` (with 1934 documented as a legacy Caddy fallback consistent with the updated 12-public-access guide). - docs/{en,zh}/guides/05-observability.md: rewrite the "Web Studio for web-based investigation" section. The standalone-bootstrap launch is gone; instead direct readers to `/studio` and its observability-relevant pages — Home (token/retrieval/context-commit trends, /api/v1/console/* BFF), Request Logs (audit), Resources, Retrieval, Sessions. Update the "choose an entry point" table accordingly. docs/design/mcp-oauth2-1.md is intentionally untouched — it's a historical design document. The README inside openviking/observability/usage_audit/ and 12-public-access.md were already updated in earlier PRs.
PR Reviewer Guide 🔍Here are some key observations to aid the review process:
|
PR Code Suggestions ✨No code suggestions found for the PR. |
qin-ctx
approved these changes
May 21, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Follow-up to #2160 (console package + port 8020 removal) and #2170 (OAuth UI moved into web-studio). Six guides still showed the old
python -m openviking.console.bootstraplaunch +-p 8020:8020docker run snippets, which now fail because the console package is gone and the image no longer exposes 8020. This PR rewrites those six pages to point readers at Web Studio (/studio, same-origin as the OV server) instead.Type of Change
Changes Made
docs/{en,zh}/getting-started/04-setup-for-agent.md— drop-p 8020:8020from the docker run example and the "ports: 1933:1933, 8020:8020" summary; note that Web Studio is served at/studioso no extra port is needed.docs/{en,zh}/guides/03-deployment.md— drop 4×-p 8020:8020snippets, replace "OpenViking Console on port 8020" with the inline/studiomention, and update the "access this after startup" list to point athttp://localhost:1933/studio(with 1934 documented as a legacy Caddy fallback, consistent with the updated12-public-access.md).docs/{en,zh}/guides/05-observability.md— rewrite the "Use OpenViking Console for web-based investigation" section. The standalone-bootstrap launch is gone; instead direct readers to/studioand its observability-relevant pages:Home(token / retrieval / context-commit trends, backed by/api/v1/console/*BFF),Request Logs(audit),Resources,Retrieval,Sessions. The "choose an entry point" table at the top is updated to match.docs/design/mcp-oauth2-1.mdis intentionally untouched — it's a historical design document explaining the original console-based OAuth flow.openviking/observability/usage_audit/README.mdanddocs/{en,zh}/guides/12-public-access.mdwere already updated in earlier PRs.Testing
grep -rn '8020\|openviking\.console' docs/returns only matches underdocs/design/(intentional).web-studioroutes (/home,/request-logs,/resources,/retrieval,/sessions,/oauth/consent).Additional Notes
Diff is +44 / −88; net reduction since the standalone-console launch instructions go away.