Skip to content

docs(ovcli.conf): note interactive setup-cli + multi-server switch from #1916#1961

Merged
ZaynJarvis merged 2 commits into
volcengine:mainfrom
r266-tech:docs-ovcli-setup-cli-switch-1916
May 10, 2026
Merged

docs(ovcli.conf): note interactive setup-cli + multi-server switch from #1916#1961
ZaynJarvis merged 2 commits into
volcengine:mainfrom
r266-tech:docs-ovcli-setup-cli-switch-1916

Conversation

@r266-tech
Copy link
Copy Markdown
Contributor

Problem

#1916 (feat: ov CLI support, MaojiaSheng → ZaynJarvis 2026-05-08) added ov config setup-cli (interactive ovcli.conf generation) and ov config switch (multi-server profile switching). The PR updated README.md (line 507) and README_CN.md (line 435) under "CLI/Client Configuration Examples", but the dedicated ovcli.conf reference section in the configuration guide (docs/{en,zh}/guides/01-configuration.md) still only describes the manual JSON edit path. Users who reach the reference doc — typically the audience reading config field tables — never learn that the file can also be generated and swapped via the CLI.

Fix

Adds one sentence at the top of each ### ovcli.conf subsection (EN + ZH), naming both subcommands and framing them as the manual-vs-interactive complement of editing by hand. Wording is grounded in #1916's own README diff — ov config setup-cli for interactive initialization, ov config switch for switching between configurations. No new fields, no behavior change, no JSON example changes.

Diff

docs/en/guides/01-configuration.md (+2):

### ovcli.conf

+You can edit this file by hand, or generate it interactively with `ov config setup-cli`. If you maintain configurations for multiple servers, switch between them with `ov config switch`.
+
 Config file for the HTTP client (`SyncHTTPClient` / `AsyncHTTPClient`) and CLI to connect to a remote server:

docs/zh/guides/01-configuration.md (+2): byte-for-byte semantic mirror in CN.

Why this isn't redundant with the README catch in #1916

The README block lives under the onboarding "CLI/Client Configuration Examples" subsection — quickstart audience. docs/{en,zh}/guides/01-configuration.md is the dedicated reference doc covering the full ovcli.conf field table, CLI flag overrides, and gitignore behavior. Reference-doc readers do not necessarily read README first; surfacing the same two commands at the top of the dedicated section closes the discoverability gap without duplicating implementation detail.

Source PR & precedent

@github-actions
Copy link
Copy Markdown

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

🎫 Ticket compliance analysis ✅

1916 - Fully compliant

Compliant requirements:

  • Documents ov config setup-cli for interactive config generation
  • Documents ov config switch for multi-server configuration switching
⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
🏅 Score: 100
🧪 No relevant tests
🔒 No security concerns identified
✅ No TODO sections
🔀 No multiple PR themes
⚡ No major issues detected

@github-actions
Copy link
Copy Markdown

PR Code Suggestions ✨

No code suggestions found for the PR.

Copy link
Copy Markdown
Collaborator

@ZaynJarvis ZaynJarvis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thx

@ZaynJarvis ZaynJarvis merged commit c479431 into volcengine:main May 10, 2026
3 checks passed
@github-project-automation github-project-automation Bot moved this from Backlog to Done in OpenViking project May 10, 2026
ZaynJarvis pushed a commit that referenced this pull request May 13, 2026
#1916 (#1961)

* docs(ovcli.conf): note interactive setup-cli + multi-server switch from #1916

* docs(ovcli.conf,zh): note interactive setup-cli + multi-server switch from #1916
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants