Skip to content

docs: document openviking-server init/doctor in README (#1454)#1455

Merged
MaojiaSheng merged 2 commits intovolcengine:mainfrom
r266-tech:docs/readme-init-doctor
Apr 15, 2026
Merged

docs: document openviking-server init/doctor in README (#1454)#1455
MaojiaSheng merged 2 commits intovolcengine:mainfrom
r266-tech:docs/readme-init-doctor

Conversation

@r266-tech
Copy link
Copy Markdown
Contributor

Summary

Fixes #1454.

v0.3.6 (#1353) introduced openviking-server init (interactive Ollama setup wizard) and openviking-server doctor (offline prerequisites validator), but neither README.md nor README_CN.md mentions them.

Adds a "Quick Setup for Local Models (Ollama)" subsection under "3. Environment Configuration" in both READMEs, showing:

  • openviking-server init for automated Ollama model detection/pull/config
  • openviking-server doctor for setup validation

This gives local-first users a clear fast path while preserving the existing manual configuration docs for cloud API users.

Type of Change

  • Documentation update

@github-actions
Copy link
Copy Markdown

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

🎫 Ticket compliance analysis ✅

1454 - Fully compliant

Compliant requirements:

  • Added documentation for openviking-server init in README.md and README_CN.md
  • Added documentation for openviking-server doctor in README.md and README_CN.md
  • Placed the documentation under "3. Environment Configuration" section
⏱️ 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.

@MaojiaSheng MaojiaSheng merged commit 72b548f into volcengine:main Apr 15, 2026
2 checks passed
@github-project-automation github-project-automation bot moved this from Backlog to Done in OpenViking project Apr 15, 2026
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.

docs: README missing openviking-server init/doctor introduced in v0.3.6

2 participants