mirror of
https://github.com/volcengine/OpenViking.git
synced 2026-09-30 01:08:26 +08:00
Zayn JarvisandClaude Fable 5
94827db8f5
* docs: revamp README for readability, route detail to docs.openviking.ai The README had grown to ~850 lines, 60% of it provider-config JSON that duplicates the deployed configuration guide. Rewritten to ~253 lines: - Lead with what the product is, a Studio screenshot, and five feature bullets, each outlinked to docs.openviking.ai - Move benchmarks (LoCoMo, tau2-bench, HotpotQA) above the fold; drop two derived tables in favor of one-sentence summaries + ./benchmark links - Collapse install to the init/doctor golden path; all provider JSON, ov.conf templates, env vars, and Windows setup now route to the configuration guide (verified live) - Add the previously missing "Use it with your agent" section linking all 10 integration docs - README_CN (zh docs links) and README_JA (en docs links; ja docs not deployed) rewritten to mirror section-for-section - New hero screenshot docs/images/studio-playground.png from openviking.ai/studio All 76 external URLs and every repo-relative link verified. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01N4oDxmJojygyomsz9BBhhn * docs: fix review findings — restore uncovered detail, drop false pointers Adversarial review of the revamp found four claims pointing at coverage that does not exist: - Restore `cargo install --git ... ov_cli` build-from-source path (was deleted with no docs destination; docset has no cargo install anywhere) - Restore `ov reindex` mode documentation (vectors_only / semantic_and_vectors / prune_orphans / --dry-run / no alias warning) — covered by no linked doc - Remove "per-agent breakdown is in ./benchmark" (benchmark/ holds reproduction scripts, not result tables) - Remove "Reproduce it from ./benchmark" on the 5-dataset RAG summary (adapters exist for only 3 of 5 datasets) Also: EN/JA quick-start grep example now targets docs/en instead of docs/zh. Applied identically to README.md, README_CN.md, README_JA.md. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01N4oDxmJojygyomsz9BBhhn * docs: apply review feedback — blog philosophy link, deployed doc links, drop dead widgets - Link the design-philosophy essay (The Database Paradigm for Context Engineering, blog.openviking.ai) from the Why section so the old README's design narrative has a durable home; add Blog to community - Switch remaining ./docs about-us links (header + community, incl. QR anchors) to docs.openviking.ai; zh anchors verified against deployed page ids (#飞书群 / #微信群) - Remove the star-history chart (service currently renders nothing) and the stale "May 2026 Update" banner line - Caption now states the Studio link is a live demo, no install needed Applied identically to README.md, README_CN.md, README_JA.md. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01N4oDxmJojygyomsz9BBhhn * docs: benchmark charts, easier quick start, logo padding - Replace the three benchmark tables with one theme-aware SVG chart (light/dark via <picture>): LoCoMo and tau2-bench as grouped bars, gray = without OpenViking, blue = with. HotpotQA leaves the README; full results link to the benchmark report on blog.openviking.ai. Hand-written SVG, exact numbers from the tables — no generated images. - Rework Quick start reading flow: nohup folds into the install block, note that pip install already ships the ov client CLI, close with a two-link "Next steps" (CLI setup, Deployment). ov reindex modes and the cargo source install move to the CLI setup doc (en+zh) so the README stays an easy entry. - Shrink logo artwork to 0.7 inside the same 842x842 canvas for breathing room. Applied to README.md, README_CN.md, README_JA.md. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01N4oDxmJojygyomsz9BBhhn * docs: enlarge logo artwork 1.1x within same canvas Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01N4oDxmJojygyomsz9BBhhn --------- Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
6.4 KiB
6.4 KiB
