Skip to content

Self-evolving Context Database for AI Agents. Unify Agent Memory, Knowledge RAG and Skills.

feat(brand): complete E rollout and tidy repository documentation (#5546)

Zayn Jarvisdf32bf6e50a4
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 01aef8b08..51e598b56 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,6 +1,8 @@
# Contributing to OpenViking
-English / [中文](CONTRIBUTING_CN.md) / [日本語](CONTRIBUTING_JA.md)
+English / [中文](docs/repository/CONTRIBUTING_CN.md) / [日本語](docs/repository/CONTRIBUTING_JA.md)
+
+Maintainer release guides: [English](docs/repository/RELEASE.md) / [中文](docs/repository/RELEASE_CN.md).
Thank you for contributing to OpenViking. This guide exists to help contributors
submit changes that are clear, focused, and practical to review.
diff --git a/README.md b/README.md
index b948c941b..4ddb69b66 100644
--- a/README.md
+++ b/README.md
@@ -2,15 +2,16 @@
<a href="https://openviking.ai/" target="_blank">
<picture>
- <img alt="OpenViking" src="docs/images/ov-logo.png" width="200px" height="auto">
+ <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/volcengine/OpenViking/f5b6043d29406ec8102402868745bdc879e48f90/docs/images/readme-logo-dark.png">
+ <img alt="OpenViking" src="https://raw.githubusercontent.com/volcengine/OpenViking/f5b6043d29406ec8102402868745bdc879e48f90/docs/images/readme-logo-light.png" width="300" height="56">
</picture>
</a>
-### OpenViking: The Context Database for AI Agents
+### The Context Database for AI Agents
-English / [中文](README_CN.md) / [日本語](README_JA.md)
+English / [中文](docs/repository/README_CN.md) / [日本語](docs/repository/README_JA.md)
-<a href="https://www.openviking.ai">Website</a> · <a href="https://openviking.ai/studio">Live Demo</a> · <a href="https://github.com/volcengine/OpenViking">GitHub</a> · <a href="https://github.com/volcengine/OpenViking/issues">Issues</a> · <a href="https://docs.openviking.ai/">Docs</a>
+<a href="https://www.openviking.ai">Website</a> · <a href="https://openviking.ai/studio">Live Demo</a> · <a href="https://github.com/volcengine/OpenViking">GitHub</a> · <a href="https://github.com/volcengine/OpenViking/issues">Issues</a> · <a href="https://docs.openviking.ai/">Docs</a> · <a href="https://blog.openviking.ai/">Blog</a>
<p>
<a href="https://github.com/volcengine/OpenViking/releases"><img src="https://img.shields.io/github/v/release/volcengine/OpenViking?color=369eff&labelColor=black&logo=github&style=flat-square" alt="release"></a>
diff --git a/bot/vikingbot/studio/providers/feishu/icon.png b/bot/vikingbot/studio/providers/feishu/icon.png
index fb9ea3329..75241adf5 100644
Binary files a/bot/vikingbot/studio/providers/feishu/icon.png and b/bot/vikingbot/studio/providers/feishu/icon.png differ
diff --git a/docs/.vitepress/brand-e.md b/docs/.vitepress/brand-e.md
index 829b66a14..6dd9b50b8 100644
--- a/docs/.vitepress/brand-e.md
+++ b/docs/.vitepress/brand-e.md
@@ -11,3 +11,27 @@ Assets originate from the approved variant E brand kit. Theme colors: Ink
Variant A remains a separate draft option. This release does not close or
merge the existing A proposals (OpenViking #5491 and playground MR #106).
Existing article illustrations are editorial images and remain unchanged.
+
+## Horizontal lockup audit
+
+README and docs navigation use one outlined SVG rather than browser-typeset
+OpenViking text. The blog uses byte-identical assets. The wordmark is **Geist
+SemiBold 600**, from the brand manual horizontal SVG: font size 84, text origin
+(126, 86), tracking -2.52 (-0.03em), next to a 112-unit mark box. Kerning is baked
+into the paths. Only the approved E tapered slash replaces the original mark.
+
+The slide caption and its SVG disagree about the mark-to-wordmark gap. These
+assets follow the actual displayed SVG (39.725 primary-grid units between ink).
+The E slash's wider base is included when retaining 10 units of clear space on
+all sides. The 500.05 × 92.94 viewBox is scaled uniformly. Ink #07090D is used on
+light surfaces and Paper #F4F5F3 on dark surfaces; no CSS filter or synthetic font.
+
+The header logo is 160px wide (112px below 375px viewport width). The separate small `/ docs` label sits outside
+the artwork and is hidden on mobile. Article typography remains independent;
+#5543 cannot alter this wordmark. README PNGs are 800px wide, displayed at 300px.
+Their absolute URLs pin the asset commit so PR previews and the next PyPI
+release both work before or after merge. Existing
+square-image URLs are retained and updated for external consumers.
+
+Studio/PWA, server/MCP, plugin and VikingBot icons use the matching E kit.
+CLI has a separate terminal adaptation because terminals choose their own font.
diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts
index 211bfde8d..86c3f31a3 100644
--- a/docs/.vitepress/config.ts
+++ b/docs/.vitepress/config.ts
@@ -9,6 +9,7 @@ const repo = process.env.GITHUB_REPOSITORY || 'volcengine/OpenViking'
const githubRepositoryUrl = `https://github.com/${repo}?utm_source=docs&utm_medium=referral&utm_campaign=docs`
const configuredBase = '/' + (process.env.DOCS_BASE || '/').split('/').filter(Boolean).join('/') + '/'
const base = configuredBase === '//' ? '/' : configuredBase
+const ogImageUrl = `${(process.env.DOCS_SITE_URL || 'https://docs.openviking.ai').replace(/\/$/, '')}${base}og-image.png`
const languageSource = fs.readFileSync(path.join(docsRoot, '.vitepress/theme/language-preference.js'), 'utf8').replace('export function', 'function')
const entrySource = fs.readFileSync(path.join(docsRoot, '.vitepress/theme/language-entry.js'), 'utf8').replace('export function', 'function')
const languageBootstrapScript = `${languageSource}\n${entrySource}\n;(() => {
@@ -82,7 +83,7 @@ function collectAllMdFiles(
function walk(dir: string) {
for (const entry of fs.readdirSync(dir)) {
- if (ignored.has(entry)) continue
+ if (ignored.has(entry) || (dir === srcDir && entry === 'repository')) continue
const abs = path.join(dir, entry)
const stat = fs.statSync(abs)
if (stat.isDirectory()) {
@@ -231,11 +232,18 @@ export default defineConfig({
// The existing Markdown corpus links to examples, bot docs, localhost snippets,
// and historical design notes that are outside the VitePress page tree.
ignoreDeadLinks: true,
+ // Repository translations and maintainer guides are browsed on GitHub.
+ srcExclude: ['repository/**'],
head: [
['link', { rel: 'icon', type: 'image/x-icon', href: `${base}favicon.ico` }],
['link', { rel: 'icon', type: 'image/png', sizes: '32x32', href: `${base}favicon-32.png` }],
['link', { rel: 'icon', type: 'image/svg+xml', href: `${base}favicon.svg` }],
['link', { rel: 'apple-touch-icon', sizes: '180x180', href: `${base}apple-touch-icon.png` }],
+ ['meta', { property: 'og:image', content: ogImageUrl }],
+ ['meta', { property: 'og:image:width', content: '1200' }],
+ ['meta', { property: 'og:image:height', content: '630' }],
+ ['meta', { name: 'twitter:card', content: 'summary_large_image' }],
+ ['meta', { name: 'twitter:image', content: ogImageUrl }],
['script', {}, preferenceBootstrapScript],
['script', {}, languageBootstrapScript]
],
@@ -284,7 +292,8 @@ export default defineConfig({
]
},
themeConfig: {
- logo: { light: '/nav-logo-light.svg', dark: '/nav-logo-dark.svg', alt: 'OpenViking' },
+ siteTitle: false,
+ logo: { light: '/brand-lockup-light.svg', dark: '/brand-lockup-dark.svg', alt: 'OpenViking' },
logoLink: base,
nav: enNav,
socialLinks: [
diff --git a/docs/.vitepress/theme/reading.css b/docs/.vitepress/theme/reading.css
index 7e0044832..cb195ed42 100644
--- a/docs/.vitepress/theme/reading.css
+++ b/docs/.vitepress/theme/reading.css
@@ -2,7 +2,7 @@
.dark { --vp-c-divider: #e9ece71c; }
.VPHome { margin-bottom: 0 !important; }
.VPNavBarTitle .title { font-size: 16px; letter-spacing: -.035em; }
-.VPNavBarTitle .logo { width: 24px; height: 24px; object-fit: contain; }
+.VPNavBarTitle .logo { width: 160px; height: auto; aspect-ratio: 500.05 / 92.94; object-fit: contain; margin-right: 0; }
.VPNavBarTitle .title::after { content: ' / docs'; font-family: var(--vp-font-family-mono); font-size: 11px; color: var(--vp-c-text-2); margin-left: 10px; letter-spacing: 0; font-weight: 400; }
.VPNavBarMenuLink { font-size: 14px !important; }
.ov-docs-search-trigger { border-radius: 5px; height: 34px; min-width: 155px; background: transparent; font-size: 14px; }
@@ -90,7 +90,7 @@
}
@media (max-width: 374px) {
.VPNav .VPNavBarTitle .title { font-size: 13px; }
- .VPNav .VPNavBarTitle .logo { width: 24px; height: 24px; margin-right: 5px; }
+ .VPNav .VPNavBarTitle .logo { width: 112px; height: auto; margin-right: 0; }
.VPNav .VPNavBar .content-body { gap: 5px; }
.VPNav .ov-docs-search-trigger { width: 43px; min-width: 43px; padding: 0 4px; }
}
diff --git a/docs/images/brand-lockup-dark.svg b/docs/images/brand-lockup-dark.svg
new file mode 100644
index 000000000..067ce33ee
--- /dev/null
+++ b/docs/images/brand-lockup-dark.svg
@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 500.05 92.94" width="500.05" height="92.94" fill="#F4F5F3"><g transform="translate(-12 -6)"><polygon points="22,84 30,84 70,16"/><polygon points="36,84 76,16 76,84"/><path d="M141.07 77.99Q133.2 77.99 127.5 74.61Q121.8 71.24 118.76 65.05Q115.72 58.86 115.72 50.24Q115.72 41.61 118.76 35.35Q121.8 29.09 127.5 25.71Q133.2 22.34 141.07 22.34Q149.03 22.34 154.73 25.71Q160.43 29.09 163.46 35.35Q166.5 41.61 166.5 50.24Q166.5 58.86 163.46 65.05Q160.43 71.24 154.73 74.61Q149.03 77.99 141.07 77.99ZM141.07 69.51Q148.35 69.51 152.4 64.45Q156.45 59.39 156.45 50.24Q156.45 41.09 152.4 35.95Q148.35 30.81 141.07 30.81Q133.95 30.81 129.86 35.95Q125.78 41.09 125.78 50.24Q125.78 59.39 129.86 64.45Q133.95 69.51 141.07 69.51ZM172.72 88.04V36.74H181.95L182.1 42.74Q183.82 39.36 186.97 37.6Q190.12 35.84 194.1 35.84Q199.8 35.84 203.59 38.65Q207.38 41.46 209.25 46.22Q211.12 50.99 211.12 56.76Q211.12 62.54 209.21 67.26Q207.3 71.99 203.51 74.84Q199.72 77.69 194.03 77.69Q190.2 77.69 187.09 76Q183.97 74.31 182.32 71.31V88.04ZM191.78 69.89Q196.12 69.89 198.64 66.4Q201.15 62.91 201.15 56.76Q201.15 50.61 198.64 47.12Q196.12 43.64 191.78 43.64Q187.42 43.64 184.88 46.94Q182.32 50.24 182.32 56.76Q182.32 63.29 184.84 66.59Q187.35 69.89 191.78 69.89ZM233.62 77.69Q227.62 77.69 223.2 75.1Q218.77 72.51 216.38 67.79Q213.97 63.06 213.97 56.76Q213.97 50.46 216.38 45.74Q218.77 41.01 223.16 38.42Q227.55 35.84 233.4 35.84Q239.1 35.84 243.38 38.39Q247.65 40.94 250.01 45.74Q252.37 50.54 252.37 57.29V59.46H223.95Q224.17 64.71 226.8 67.37Q229.42 70.04 233.7 70.04Q240.22 70.04 242.02 64.49L251.85 65.09Q250.2 70.94 245.36 74.31Q240.52 77.69 233.62 77.69ZM223.95 53.01H242.47Q242.1 48.14 239.66 45.77Q237.22 43.41 233.4 43.41Q229.5 43.41 227.02 45.89Q224.55 48.36 223.95 53.01ZM257.62 76.79V36.74H266.32L266.55 43.56Q268.2 39.44 271.39 37.64Q274.57 35.84 278.55 35.84Q285.15 35.84 288.67 40.07Q292.2 44.31 292.2 51.06V76.79H282.6V54.14Q282.6 49.04 281.06 46.34Q279.52 43.64 275.62 43.64Q271.72 43.64 269.47 46.34Q267.22 49.04 267.22 54.14V76.79ZM314.4 76.79 295.12 23.54H305.4L320.32 65.91L335.18 23.54H345.45L326.1 76.79ZM348 76.79V36.74H357.6V76.79ZM347.85 31.41V22.86H357.82V31.41ZM364.73 76.79V23.54H374.33V54.81L390.75 36.74H402.6L386.93 53.39L403.12 76.79H392.33L380.62 59.09L374.33 65.76V76.79ZM405.83 76.79V36.74H415.43V76.79ZM405.68 31.41V22.86H415.65V31.41ZM424.2 76.79V36.74H432.9L433.13 43.56Q434.78 39.44 437.96 37.64Q441.15 35.84 445.13 35.84Q451.73 35.84 455.25 40.07Q458.78 44.31 458.78 51.06V76.79H449.18V54.14Q449.18 49.04 447.64 46.34Q446.1 43.64 442.2 43.64Q438.3 43.64 436.05 46.34Q433.8 49.04 433.8 54.14V76.79ZM483.15 88.94Q475.28 88.94 470.78 85.79Q466.28 82.64 464.93 77.54L474.83 76.86Q475.58 79.19 477.41 80.42Q479.25 81.66 483.15 81.66Q487.58 81.66 489.98 79.67Q492.38 77.69 492.38 73.49V68.39Q490.95 71.31 487.8 73.07Q484.65 74.84 480.75 74.84Q475.8 74.84 471.94 72.4Q468.08 69.96 465.9 65.57Q463.73 61.19 463.73 55.41Q463.73 49.64 465.9 45.25Q468.08 40.86 471.86 38.35Q475.65 35.84 480.6 35.84Q484.88 35.84 488.03 37.79Q491.18 39.74 492.68 42.96V36.74H502.05V73.26Q502.05 80.99 496.88 84.96Q491.7 88.94 483.15 88.94ZM483 67.34Q487.28 67.34 489.86 64.15Q492.45 60.96 492.45 55.34Q492.53 49.79 489.94 46.56Q487.35 43.34 483 43.34Q478.58 43.34 476.14 46.6Q473.7 49.86 473.7 55.34Q473.7 60.81 476.21 64.07Q478.73 67.34 483 67.34Z"/></g></svg>
diff --git a/docs/images/brand-lockup-light.svg b/docs/images/brand-lockup-light.svg
new file mode 100644
index 000000000..f787ed76f
--- /dev/null
+++ b/docs/images/brand-lockup-light.svg
@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 500.05 92.94" width="500.05" height="92.94" fill="#07090D"><g transform="translate(-12 -6)"><polygon points="22,84 30,84 70,16"/><polygon points="36,84 76,16 76,84"/><path d="M141.07 77.99Q133.2 77.99 127.5 74.61Q121.8 71.24 118.76 65.05Q115.72 58.86 115.72 50.24Q115.72 41.61 118.76 35.35Q121.8 29.09 127.5 25.71Q133.2 22.34 141.07 22.34Q149.03 22.34 154.73 25.71Q160.43 29.09 163.46 35.35Q166.5 41.61 166.5 50.24Q166.5 58.86 163.46 65.05Q160.43 71.24 154.73 74.61Q149.03 77.99 141.07 77.99ZM141.07 69.51Q148.35 69.51 152.4 64.45Q156.45 59.39 156.45 50.24Q156.45 41.09 152.4 35.95Q148.35 30.81 141.07 30.81Q133.95 30.81 129.86 35.95Q125.78 41.09 125.78 50.24Q125.78 59.39 129.86 64.45Q133.95 69.51 141.07 69.51ZM172.72 88.04V36.74H181.95L182.1 42.74Q183.82 39.36 186.97 37.6Q190.12 35.84 194.1 35.84Q199.8 35.84 203.59 38.65Q207.38 41.46 209.25 46.22Q211.12 50.99 211.12 56.76Q211.12 62.54 209.21 67.26Q207.3 71.99 203.51 74.84Q199.72 77.69 194.03 77.69Q190.2 77.69 187.09 76Q183.97 74.31 182.32 71.31V88.04ZM191.78 69.89Q196.12 69.89 198.64 66.4Q201.15 62.91 201.15 56.76Q201.15 50.61 198.64 47.12Q196.12 43.64 191.78 43.64Q187.42 43.64 184.88 46.94Q182.32 50.24 182.32 56.76Q182.32 63.29 184.84 66.59Q187.35 69.89 191.78 69.89ZM233.62 77.69Q227.62 77.69 223.2 75.1Q218.77 72.51 216.38 67.79Q213.97 63.06 213.97 56.76Q213.97 50.46 216.38 45.74Q218.77 41.01 223.16 38.42Q227.55 35.84 233.4 35.84Q239.1 35.84 243.38 38.39Q247.65 40.94 250.01 45.74Q252.37 50.54 252.37 57.29V59.46H223.95Q224.17 64.71 226.8 67.37Q229.42 70.04 233.7 70.04Q240.22 70.04 242.02 64.49L251.85 65.09Q250.2 70.94 245.36 74.31Q240.52 77.69 233.62 77.69ZM223.95 53.01H242.47Q242.1 48.14 239.66 45.77Q237.22 43.41 233.4 43.41Q229.5 43.41 227.02 45.89Q224.55 48.36 223.95 53.01ZM257.62 76.79V36.74H266.32L266.55 43.56Q268.2 39.44 271.39 37.64Q274.57 35.84 278.55 35.84Q285.15 35.84 288.67 40.07Q292.2 44.31 292.2 51.06V76.79H282.6V54.14Q282.6 49.04 281.06 46.34Q279.52 43.64 275.62 43.64Q271.72 43.64 269.47 46.34Q267.22 49.04 267.22 54.14V76.79ZM314.4 76.79 295.12 23.54H305.4L320.32 65.91L335.18 23.54H345.45L326.1 76.79ZM348 76.79V36.74H357.6V76.79ZM347.85 31.41V22.86H357.82V31.41ZM364.73 76.79V23.54H374.33V54.81L390.75 36.74H402.6L386.93 53.39L403.12 76.79H392.33L380.62 59.09L374.33 65.76V76.79ZM405.83 76.79V36.74H415.43V76.79ZM405.68 31.41V22.86H415.65V31.41ZM424.2 76.79V36.74H432.9L433.13 43.56Q434.78 39.44 437.96 37.64Q441.15 35.84 445.13 35.84Q451.73 35.84 455.25 40.07Q458.78 44.31 458.78 51.06V76.79H449.18V54.14Q449.18 49.04 447.64 46.34Q446.1 43.64 442.2 43.64Q438.3 43.64 436.05 46.34Q433.8 49.04 433.8 54.14V76.79ZM483.15 88.94Q475.28 88.94 470.78 85.79Q466.28 82.64 464.93 77.54L474.83 76.86Q475.58 79.19 477.41 80.42Q479.25 81.66 483.15 81.66Q487.58 81.66 489.98 79.67Q492.38 77.69 492.38 73.49V68.39Q490.95 71.31 487.8 73.07Q484.65 74.84 480.75 74.84Q475.8 74.84 471.94 72.4Q468.08 69.96 465.9 65.57Q463.73 61.19 463.73 55.41Q463.73 49.64 465.9 45.25Q468.08 40.86 471.86 38.35Q475.65 35.84 480.6 35.84Q484.88 35.84 488.03 37.79Q491.18 39.74 492.68 42.96V36.74H502.05V73.26Q502.05 80.99 496.88 84.96Q491.7 88.94 483.15 88.94ZM483 67.34Q487.28 67.34 489.86 64.15Q492.45 60.96 492.45 55.34Q492.53 49.79 489.94 46.56Q487.35 43.34 483 43.34Q478.58 43.34 476.14 46.6Q473.7 49.86 473.7 55.34Q473.7 60.81 476.21 64.07Q478.73 67.34 483 67.34Z"/></g></svg>
diff --git a/docs/images/og-image.png b/docs/images/og-image.png
new file mode 100644
index 000000000..7a1b91d2b
Binary files /dev/null and b/docs/images/og-image.png differ
diff --git a/docs/images/ov-logo-icon.png b/docs/images/ov-logo-icon.png
index 383182f34..5b0c95a70 100644
Binary files a/docs/images/ov-logo-icon.png and b/docs/images/ov-logo-icon.png differ
diff --git a/docs/images/ov-logo-square.png b/docs/images/ov-logo-square.png
index a8889d94d..799d1303e 100644
Binary files a/docs/images/ov-logo-square.png and b/docs/images/ov-logo-square.png differ
diff --git a/docs/images/readme-logo-dark.png b/docs/images/readme-logo-dark.png
new file mode 100644
index 000000000..f261d99fc
Binary files /dev/null and b/docs/images/readme-logo-dark.png differ
diff --git a/docs/images/readme-logo-light.png b/docs/images/readme-logo-light.png
new file mode 100644
index 000000000..57d50bc75
Binary files /dev/null and b/docs/images/readme-logo-light.png differ
diff --git a/CONTRIBUTING_CN.md b/docs/repository/CONTRIBUTING_CN.md
similarity index 97%
rename from CONTRIBUTING_CN.md
rename to docs/repository/CONTRIBUTING_CN.md
index d174dd811..01d0124f4 100644
--- a/CONTRIBUTING_CN.md
+++ b/docs/repository/CONTRIBUTING_CN.md
@@ -1,6 +1,6 @@
# 为 OpenViking 做贡献
-[English](CONTRIBUTING.md) / 中文 / [日本語](CONTRIBUTING_JA.md)
+[English](../../CONTRIBUTING.md) / 中文 / [日本語](CONTRIBUTING_JA.md)
感谢你参与 OpenViking。本指南旨在帮助贡献者提交清晰、聚焦且便于评审的改动。
@@ -175,7 +175,7 @@ SDK、Integration、Plugin 和 Benchmark 可能有额外要求,请查看对应
涉及上述边界的修改,必须沿真实调用链追踪不可信输入,覆盖相关 API、服务层、原生绑定层、外部程序和文件系统操作。在相应边界验证形似命令选项的输入、Shell 特殊字符、特制文件内容、路径穿越、符号链接和跨租户访问。通过聚焦的契约测试或范围受控的复现进行验证;正常请求成功不能证明隔离有效。
-命令或参数注入、任意服务器文件访问,以及突破预定执行边界或租户边界的行为都属于安全问题。疑似问题应通过 [SECURITY.md](SECURITY.md) 中的私密渠道报告。公开文档和 PR 应说明必须遵守的安全边界,不得披露尚未修复问题的利用方法或敏感数据。
+命令或参数注入、任意服务器文件访问,以及突破预定执行边界或租户边界的行为都属于安全问题。疑似问题应通过 [SECURITY.md](../../SECURITY.md) 中的私密渠道报告。公开文档和 PR 应说明必须遵守的安全边界,不得披露尚未修复问题的利用方法或敏感数据。
### 代码风格
diff --git a/CONTRIBUTING_JA.md b/docs/repository/CONTRIBUTING_JA.md
similarity index 98%
rename from CONTRIBUTING_JA.md
rename to docs/repository/CONTRIBUTING_JA.md
index eaaf9e6b2..3e4ab7f2d 100644
--- a/CONTRIBUTING_JA.md
+++ b/docs/repository/CONTRIBUTING_JA.md
@@ -1,6 +1,6 @@
# OpenVikingへのコントリビューション
-[English](CONTRIBUTING.md) / [中文](CONTRIBUTING_CN.md) / 日本語
+[English](../../CONTRIBUTING.md) / [中文](CONTRIBUTING_CN.md) / 日本語
OpenVikingへのコントリビューションありがとうございます。このガイドは、明確で
焦点が絞られ、レビューしやすい変更を提出するためのものです。
@@ -189,7 +189,7 @@ SDK、Integration、Plugin、Benchmarkには追加のセットアップ手順が
これらの境界に影響する変更では、信頼できない入力を、該当する実際のAPI、サービス、ネイティブバインディング、外部プログラム、ファイルシステム操作まで追跡してください。関連する境界で、オプションに見える値、シェルの特殊文字、細工されたファイル内容、パストラバーサル、シンボリックリンク、テナントをまたぐアクセスを検証してください。焦点を絞った契約テストや範囲を制限した再現で確認してください。通常のリクエストが成功するだけでは、隔離の有効性を証明できません。
-コマンドや引数のインジェクション、任意のサーバーファイルへのアクセス、意図した実行境界やテナント境界からの逸脱は、セキュリティ問題です。疑わしい問題は[SECURITY.md](SECURITY.md)に記載された非公開の窓口から報告してください。公開ドキュメントやPRでは必要な境界を説明し、未修正の問題の悪用方法や機密データを公開しないでください。
+コマンドや引数のインジェクション、任意のサーバーファイルへのアクセス、意図した実行境界やテナント境界からの逸脱は、セキュリティ問題です。疑わしい問題は[SECURITY.md](../../SECURITY.md)に記載された非公開の窓口から報告してください。公開ドキュメントやPRでは必要な境界を説明し、未修正の問題の悪用方法や機密データを公開しないでください。
### コードスタイル
diff --git a/README_CN.md b/docs/repository/README_CN.md
similarity index 77%
rename from README_CN.md
rename to docs/repository/README_CN.md
index ca6318361..200c2536e 100644
--- a/README_CN.md
+++ b/docs/repository/README_CN.md
@@ -2,15 +2,16 @@
<a href="https://openviking.ai/" target="_blank">
<picture>
- <img alt="OpenViking" src="docs/images/ov-logo.png" width="200px" height="auto">
+ <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/volcengine/OpenViking/f5b6043d29406ec8102402868745bdc879e48f90/docs/images/readme-logo-dark.png">
+ <img alt="OpenViking" src="https://raw.githubusercontent.com/volcengine/OpenViking/f5b6043d29406ec8102402868745bdc879e48f90/docs/images/readme-logo-light.png" width="300" height="56">
</picture>
</a>
-### OpenViking:AI 智能体的上下文数据库
+### AI 智能体的上下文数据库
-[English](README.md) / 中文 / [日本語](README_JA.md)
+[English](../../README.md) / 中文 / [日本語](README_JA.md)
-<a href="https://www.openviking.ai">官网</a> · <a href="https://openviking.ai/studio">在线体验</a> · <a href="https://github.com/volcengine/OpenViking">GitHub</a> · <a href="https://github.com/volcengine/OpenViking/issues">问题反馈</a> · <a href="https://docs.openviking.ai/">文档</a>
+<a href="https://www.openviking.ai">官网</a> · <a href="https://openviking.ai/studio">在线体验</a> · <a href="https://github.com/volcengine/OpenViking">GitHub</a> · <a href="https://github.com/volcengine/OpenViking/issues">问题反馈</a> · <a href="https://docs.openviking.ai/">文档</a> · <a href="https://blog.openviking.ai/">博客</a>
<p>
<a href="https://github.com/volcengine/OpenViking/releases"><img src="https://img.shields.io/github/v/release/volcengine/OpenViking?color=369eff&labelColor=black&logo=github&style=flat-square" alt="release"></a>
@@ -26,10 +27,10 @@
</p>
<p>
- <a href="https://docs.openviking.ai/zh/about/01-about-us#飞书群"><img src="docs/images/community/lark.svg" width="18" height="18" alt="飞书">&nbsp;飞书</a> ·
- <a href="https://docs.openviking.ai/zh/about/01-about-us#微信群"><img src="docs/images/community/wechat.svg" width="18" height="18" alt="微信">&nbsp;微信</a> ·
- <a href="https://discord.com/invite/eHvx8E9XF3"><img src="docs/images/community/discord.svg" width="18" height="18" alt="Discord">&nbsp;Discord</a> ·
- <a href="https://x.com/openvikingai"><picture><source media="(prefers-color-scheme: dark)" srcset="docs/images/community/x-dark.svg"><img src="docs/images/community/x.svg" width="16" height="16" alt="X"></picture>&nbsp;X</a>
+ <a href="https://docs.openviking.ai/zh/about/01-about-us#飞书群"><img src="../images/community/lark.svg" width="18" height="18" alt="飞书">&nbsp;飞书</a> ·
+ <a href="https://docs.openviking.ai/zh/about/01-about-us#微信群"><img src="../images/community/wechat.svg" width="18" height="18" alt="微信">&nbsp;微信</a> ·
+ <a href="https://discord.com/invite/eHvx8E9XF3"><img src="../images/community/discord.svg" width="18" height="18" alt="Discord">&nbsp;Discord</a> ·
+ <a href="https://x.com/openvikingai"><picture><source media="(prefers-color-scheme: dark)" srcset="../images/community/x-dark.svg"><img src="../images/community/x.svg" width="16" height="16" alt="X"></picture>&nbsp;X</a>
</p>
<a href="https://trendshift.io/repositories/19668" target="_blank"><img src="https://trendshift.io/api/badge/repositories/19668" alt="volcengine%2FOpenViking | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a>
@@ -46,12 +47,12 @@ OpenViking 是面向 AI 智能体的开源上下文数据库——用一个文
<a href="https://openviking.ai/studio" target="_blank" rel="noopener noreferrer">
<picture>
- <source media="(prefers-color-scheme: dark)" srcset="docs/images/studio-playground-dark.png">
- <img src="docs/images/studio-playground.png" alt="OpenViking Studio:浏览上下文,体验语义检索">
+ <source media="(prefers-color-scheme: dark)" srcset="../images/studio-playground-dark.png">
+ <img src="../images/studio-playground.png" alt="OpenViking Studio:浏览上下文,体验语义检索">
</picture>
</a>
-[在线体验 OpenViking Studio](https://openviking.ai/studio),无需安装。 [自行部署 Web Studio](web-studio/README_CN.md)。
+[在线体验 OpenViking Studio](https://openviking.ai/studio),无需安装。 [自行部署 Web Studio](../../web-studio/README_CN.md)。
## 为什么用 OpenViking
@@ -107,13 +108,13 @@ viking://resources/my_project/
## 评测结果
-OpenViking 0.3.22 的评测覆盖长对话用户记忆(LoCoMo)和多轮智能体任务(tau2-bench)。完整结果和实验设置(含知识库问答)见[评测报告](https://blog.openviking.ai/post/openviking-benchmark-results/),复现脚本在 [./benchmark](./benchmark)。
+OpenViking 0.3.22 的评测覆盖长对话用户记忆(LoCoMo)和多轮智能体任务(tau2-bench)。完整结果和实验设置(含知识库问答)见[评测报告](https://blog.openviking.ai/post/openviking-benchmark-results/),复现脚本在 [./benchmark](../../benchmark)。
记忆评测使用 [Doubao 2.0 Pro](https://console.volcengine.com/ark/region:cn-beijing/model/detail?Id=doubao-seed-2-0-pro) 作为 VLM,使用 [Doubao-embedding-vision-251215](https://console.volcengine.com/ark/region:cn-beijing/model/detail?Id=doubao-embedding-vision) 作为 Embedding 模型。
<picture>
- <source media="(prefers-color-scheme: dark)" srcset="docs/images/benchmark-dark.svg">
- <img alt="Benchmark results. LoCoMo accuracy: OpenClaw 24.20% native vs 82.08% with OpenViking; Hermes 33.38% vs 82.86%; Claude Code 57.21% vs 80.32%. tau2-bench task success: Retail 70.94% vs 77.81%; Airline 54.38% vs 66.25%." src="docs/images/benchmark-light.svg">
+ <source media="(prefers-color-scheme: dark)" srcset="../images/benchmark-dark.svg">
+ <img alt="Benchmark results. LoCoMo accuracy: OpenClaw 24.20% native vs 82.08% with OpenViking; Hermes 33.38% vs 82.86%; Claude Code 57.21% vs 80.32%. tau2-bench task success: Retail 70.94% vs 77.81%; Airline 54.38% vs 66.25%." src="../images/benchmark-light.svg">
</picture>
- **用户记忆(LoCoMo)**:接入 OpenViking 后,三种 Agent 集成的准确率都到 80–83%,原生记忆只有 24–57%;同时输入 token 减少 34.3%–91.0%,查询时延降低 58.45%–66.10%。
@@ -179,7 +180,7 @@ ov grep "openviking" --uri viking://resources/volcengine/OpenViking/docs/zh
`ov find` 返回匹配的上下文及其 URI,可继续查看内容。客户端配置(`ov config`)、CLI 独立安装和索引维护,见 [CLI 安装](https://docs.openviking.ai/zh/getting-started/05-cli-setup)。
-构建自己的应用,可使用 [Python](sdk/python/README_CN.md)、[Go](sdk/go/README_CN.md)、[TypeScript](sdk/typescript/README_CN.md) SDK 或 [HTTP API](https://docs.openviking.ai/zh/api/01-overview)。
+构建自己的应用,可使用 [Python](../../sdk/python/README_CN.md)、[Go](../../sdk/go/README_CN.md)、[TypeScript](../../sdk/typescript/README_CN.md) SDK 或 [HTTP API](https://docs.openviking.ai/zh/api/01-overview)。
## 接入你的 Agent
@@ -240,27 +241,27 @@ Codex 首次启动会停在 `Hooks need review`,选 `Trust all and continue`
<tbody>
<tr>
<td align="center" valign="bottom" width="16%">
-<a href="https://docs.openviking.ai/zh/agent-integrations/02-claude-code"><img src="docs/images/integrations/logos/claude-code.png" width="32" height="32" alt=""><br><strong>Claude</strong></a><br>
+<a href="https://docs.openviking.ai/zh/agent-integrations/02-claude-code"><img src="../images/integrations/logos/claude-code.png" width="32" height="32" alt=""><br><strong>Claude</strong></a><br>
<sub>Hooks&nbsp;+&nbsp;MCP</sub>
</td>
<td align="center" valign="bottom" width="16%">
-<a href="https://docs.openviking.ai/zh/agent-integrations/04-codex"><picture><source media="(prefers-color-scheme: dark)" srcset="docs/images/integrations/logos/openai-dark.svg"><img src="docs/images/integrations/logos/openai.svg" width="32" height="32" alt=""></picture><br><strong>Codex</strong></a><br>
+<a href="https://docs.openviking.ai/zh/agent-integrations/04-codex"><picture><source media="(prefers-color-scheme: dark)" srcset="../images/integrations/logos/openai-dark.svg"><img src="../images/integrations/logos/openai.svg" width="32" height="32" alt=""></picture><br><strong>Codex</strong></a><br>
<sub>Hooks&nbsp;+&nbsp;MCP</sub>
</td>
<td align="center" valign="bottom" width="16%">
-<a href="https://docs.openviking.ai/zh/agent-integrations/12-cursor"><img src="docs/images/integrations/logos/cursor.png" width="32" height="32" alt=""><br><strong>Cursor</strong></a><br>
+<a href="https://docs.openviking.ai/zh/agent-integrations/12-cursor"><img src="../images/integrations/logos/cursor.png" width="32" height="32" alt=""><br><strong>Cursor</strong></a><br>
<sub>Hooks&nbsp;+&nbsp;MCP</sub>
</td>
<td align="center" valign="bottom" width="16%">
-<a href="https://docs.openviking.ai/zh/agent-integrations/13-trae"><img src="docs/images/integrations/logos/trae.png" width="32" height="32" alt=""><br><strong>TRAE</strong></a><br>
+<a href="https://docs.openviking.ai/zh/agent-integrations/13-trae"><img src="../images/integrations/logos/trae.png" width="32" height="32" alt=""><br><strong>TRAE</strong></a><br>
<sub>Hooks&nbsp;+&nbsp;MCP</sub>
</td>
<td align="center" valign="bottom" width="16%">
-<a href="https://docs.openviking.ai/zh/agent-integrations/03-openclaw"><img src="docs/images/integrations/logos/openclaw.png" width="32" height="32" alt=""><br><strong>OpenClaw</strong></a><br>
+<a href="https://docs.openviking.ai/zh/agent-integrations/03-openclaw"><img src="../images/integrations/logos/openclaw.png" width="32" height="32" alt=""><br><strong>OpenClaw</strong></a><br>
<sub>上下文引擎</sub>
</td>
<td align="center" valign="bottom" width="16%">
-<a href="https://docs.openviking.ai/zh/agent-integrations/05-hermes"><img src="docs/images/integrations/logos/hermes-agent.png" width="32" height="32" alt=""><br><strong>Hermes</strong></a><br>
+<a href="https://docs.openviking.ai/zh/agent-integrations/05-hermes"><img src="../images/integrations/logos/hermes-agent.png" width="32" height="32" alt=""><br><strong>Hermes</strong></a><br>
<sub>内置记忆</sub>
</td>
</tr>
@@ -268,27 +269,27 @@ Codex 首次启动会停在 `Hooks need review`,选 `Trust all and continue`
<tbody>
<tr>
<td align="center" valign="bottom" width="16%">
-<a href="https://docs.openviking.ai/zh/agent-integrations/10-opencode"><img src="docs/images/integrations/logos/opencode.png" width="32" height="32" alt=""><br><strong>OpenCode</strong></a><br>
+<a href="https://docs.openviking.ai/zh/agent-integrations/10-opencode"><img src="../images/integrations/logos/opencode.png" width="32" height="32" alt=""><br><strong>OpenCode</strong></a><br>
<sub>Plugin&nbsp;+&nbsp;MCP</sub>
</td>
<td align="center" valign="bottom" width="16%">
-<a href="https://docs.openviking.ai/zh/agent-integrations/11-pi"><picture><source media="(prefers-color-scheme: dark)" srcset="docs/images/integrations/logos/pi-dark.svg"><img src="docs/images/integrations/logos/pi.svg" width="32" height="32" alt=""></picture><br><strong>pi</strong></a><br>
+<a href="https://docs.openviking.ai/zh/agent-integrations/11-pi"><picture><source media="(prefers-color-scheme: dark)" srcset="../images/integrations/logos/pi-dark.svg"><img src="../images/integrations/logos/pi.svg" width="32" height="32" alt=""></picture><br><strong>pi</strong></a><br>
<sub>原生扩展</sub>
</td>
<td align="center" valign="bottom" width="16%">
-<a href="docs/images/agents/zh/deerflow-memory-manager.md"><picture><source media="(prefers-color-scheme: dark)" srcset="docs/images/integrations/logos/deerflow-dark.svg"><img src="docs/images/integrations/logos/deerflow.svg" width="32" height="32" alt=""></picture><br><strong>DeerFlow</strong></a><br>
+<a href="../images/agents/zh/deerflow-memory-manager.md"><picture><source media="(prefers-color-scheme: dark)" srcset="../images/integrations/logos/deerflow-dark.svg"><img src="../images/integrations/logos/deerflow.svg" width="32" height="32" alt=""></picture><br><strong>DeerFlow</strong></a><br>
<sub>Plugin&nbsp;+&nbsp;MCP</sub>
</td>
<td align="center" valign="bottom" width="16%">
-<a href="https://docs.openviking.ai/zh/agent-integrations/17-dsh"><picture><source media="(prefers-color-scheme: dark)" srcset="docs/images/integrations/logos/dsh-dark.svg"><img src="docs/images/integrations/logos/dsh.svg" width="32" height="32" alt=""></picture><br><strong>DSH</strong></a><br>
+<a href="https://docs.openviking.ai/zh/agent-integrations/17-dsh"><picture><source media="(prefers-color-scheme: dark)" srcset="../images/integrations/logos/dsh-dark.svg"><img src="../images/integrations/logos/dsh.svg" width="32" height="32" alt=""></picture><br><strong>DSH</strong></a><br>
<sub>Plugin&nbsp;+&nbsp;MCP</sub>
</td>
<td align="center" valign="bottom" width="16%">
-<a href="docs/images/agents/zh/doubao-work.md"><img src="docs/images/integrations/logos/doubao-work.png" width="32" height="32" alt=""><br><strong>豆包工作</strong></a><br>
+<a href="../images/agents/zh/doubao-work.md"><img src="../images/integrations/logos/doubao-work.png" width="32" height="32" alt=""><br><strong>豆包工作</strong></a><br>
<sub>连接器</sub>
</td>
<td align="center" valign="bottom" width="16%">
-<a href="https://docs.openviking.ai/zh/agent-integrations/07-langchain-langgraph"><img src="docs/images/integrations/logos/langchain.svg" width="32" height="32" alt=""><br><strong>LangChain</strong></a><br>
+<a href="https://docs.openviking.ai/zh/agent-integrations/07-langchain-langgraph"><img src="../images/integrations/logos/langchain.svg" width="32" height="32" alt=""><br><strong>LangChain</strong></a><br>
<sub>工具&nbsp;+&nbsp;存储</sub>
</td>
</tr>
@@ -300,10 +301,10 @@ Codex 首次启动会停在 `Hooks need review`,选 `Trust all and continue`
<table>
<tr>
<td align="center" valign="bottom" width="50%">
-<a href="https://docs.openviking.ai/zh/agent-integrations/15-agent-plugins"><img src="docs/images/integrations/logos/agent-plugins.svg" width="32" height="32" alt=""><br><strong>Agent&nbsp;Plugins&nbsp;1.0</strong></a>
+<a href="https://docs.openviking.ai/zh/agent-integrations/15-agent-plugins"><img src="../images/integrations/logos/agent-plugins.svg" width="32" height="32" alt=""><br><strong>Agent&nbsp;Plugins&nbsp;1.0</strong></a>
</td>
<td align="center" valign="bottom" width="50%">
-<a href="https://docs.openviking.ai/zh/agent-integrations/06-mcp-clients"><img src="docs/images/integrations/logos/mcp.svg" width="32" height="32" alt=""><br><strong>MCP&nbsp;客&#8288;户&#8288;端</strong></a>
+<a href="https://docs.openviking.ai/zh/agent-integrations/06-mcp-clients"><img src="../images/integrations/logos/mcp.svg" width="32" height="32" alt=""><br><strong>MCP&nbsp;客&#8288;户&#8288;端</strong></a>
</td>
</tr>
</table>
@@ -334,7 +335,7 @@ ov chat # 在另一个终端运行
## 生产部署
-开源服务器采用 [AGPLv3](LICENSE),可在自己的环境部署,无需激活码。见[服务器配置](https://docs.openviking.ai/zh/getting-started/03-quickstart-server)和 [Docker 与部署指南](https://docs.openviking.ai/zh/guides/03-deployment)。
+开源服务器采用 [AGPLv3](../../LICENSE),可在自己的环境部署,无需激活码。见[服务器配置](https://docs.openviking.ai/zh/getting-started/03-quickstart-server)和 [Docker 与部署指南](https://docs.openviking.ai/zh/guides/03-deployment)。
服务器支持[账号与用户隔离](https://docs.openviking.ai/zh/concepts/11-multi-tenant),并可按需启用[资源 ACL](https://docs.openviking.ai/zh/concepts/15-acl)。开放非本机访问前,需配置[身份认证](https://docs.openviking.ai/zh/guides/04-authentication)。
@@ -344,7 +345,7 @@ ov chat # 在另一个终端运行
<tr>
<td width="50%" valign="top">
-<img src="docs/images/commercial-saas.png" alt="商业化 SaaS 版" width="100%" />
+<img src="../images/commercial-saas.png" alt="商业化 SaaS 版" width="100%" />
<h3>☁️ 商业化 SaaS 版</h3>
<p>由<a href="https://www.volcengine.com/product/openviking-service">火山引擎</a>托管和运维,提供个人版、企业版,以及开源部署的迁移工具。套餐与额度见<a href="https://docs.volcengine.com/docs/84313/2374478">服务文档</a>。中国以外地区的托管服务计划在 <a href="https://www.byteplus.com">BytePlus</a> 上线。</p>
@@ -352,7 +353,7 @@ ov chat # 在另一个终端运行
</td>
<td width="50%" valign="top">
-<img src="docs/images/commercial-self-hosted.png" alt="私有化部署版" width="100%" />
+<img src="../images/commercial-self-hosted.png" alt="私有化部署版" width="100%" />
<h3>🏢 私有化部署版</h3>
<p>部署在自己的云账号 / VPC(BYOC)或离线环境中,提供分布式部署和官方技术支持,通过激活码启用。<a href="https://my.feishu.cn/share/base/form/shrcnMFqymCd9sq77sLk34Krxoc">咨询私有化部署</a>。</p>
@@ -398,7 +399,7 @@ ov chat # 在另一个终端运行
- **文档**:[docs.openviking.ai](https://docs.openviking.ai/) · [FAQ](https://docs.openviking.ai/zh/faq/faq)
- **博客**:[blog.openviking.ai](https://blog.openviking.ai/)
- **团队**:[关于我们](https://docs.openviking.ai/zh/about/01-about-us)
-- **交流**:<a href="https://docs.openviking.ai/zh/about/01-about-us#飞书群"><img src="docs/images/community/lark.svg" width="18" height="18" alt="飞书">&nbsp;飞书</a> · <a href="https://docs.openviking.ai/zh/about/01-about-us#微信群"><img src="docs/images/community/wechat.svg" width="18" height="18" alt="微信">&nbsp;微信</a> · <a href="https://discord.com/invite/eHvx8E9XF3"><img src="docs/images/community/discord.svg" width="18" height="18" alt="Discord">&nbsp;Discord</a> · <a href="https://x.com/openvikingai"><picture><source media="(prefers-color-scheme: dark)" srcset="docs/images/community/x-dark.svg"><img src="docs/images/community/x.svg" width="16" height="16" alt="X"></picture>&nbsp;X</a>
+- **交流**:<a href="https://docs.openviking.ai/zh/about/01-about-us#飞书群"><img src="../images/community/lark.svg" width="18" height="18" alt="飞书">&nbsp;飞书</a> · <a href="https://docs.openviking.ai/zh/about/01-about-us#微信群"><img src="../images/community/wechat.svg" width="18" height="18" alt="微信">&nbsp;微信</a> · <a href="https://discord.com/invite/eHvx8E9XF3"><img src="../images/community/discord.svg" width="18" height="18" alt="Discord">&nbsp;Discord</a> · <a href="https://x.com/openvikingai"><picture><source media="(prefers-color-scheme: dark)" srcset="../images/community/x-dark.svg"><img src="../images/community/x.svg" width="16" height="16" alt="X"></picture>&nbsp;X</a>
- **贡献**:修 bug、加新功能都欢迎——见 [CONTRIBUTING_CN.md](CONTRIBUTING_CN.md)
<a href="https://github.com/volcengine/OpenViking/graphs/contributors">
@@ -407,13 +408,13 @@ ov chat # 在另一个终端运行
## 安全与隐私
-漏洞报告方式和受支持的版本,见 [SECURITY.md](SECURITY.md)
+漏洞报告方式和受支持的版本,见 [SECURITY.md](../../SECURITY.md)
## 许可证
OpenViking 各组件采用不同的许可证:
-- **主项目**:AGPLv3——详见 [LICENSE](./LICENSE)
-- **crates/ov\_cli**:Apache 2.0——详见 [LICENSE](./crates/LICENSE)
-- **examples**:Apache 2.0——详见 [LICENSE](./examples/LICENSE)。`examples/hermes-plugin` 中的 Hermes 插件保留其 [MIT 许可证](./examples/hermes-plugin/LICENSE)。
+- **主项目**:AGPLv3——详见 [LICENSE](../../LICENSE)
+- **crates/ov\_cli**:Apache 2.0——详见 [LICENSE](../../crates/LICENSE)
+- **examples**:Apache 2.0——详见 [LICENSE](../../examples/LICENSE)。`examples/hermes-plugin` 中的 Hermes 插件保留其 [MIT 许可证](../../examples/hermes-plugin/LICENSE)。
- **third\_party**:各三方项目保留其原有协议
diff --git a/README_JA.md b/docs/repository/README_JA.md
similarity index 80%
rename from README_JA.md
rename to docs/repository/README_JA.md
index fc1e68cf4..b968127d9 100644
--- a/README_JA.md
+++ b/docs/repository/README_JA.md
@@ -2,15 +2,16 @@
<a href="https://openviking.ai/" target="_blank">
<picture>
- <img alt="OpenViking" src="docs/images/ov-logo.png" width="200px" height="auto">
+ <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/volcengine/OpenViking/f5b6043d29406ec8102402868745bdc879e48f90/docs/images/readme-logo-dark.png">
+ <img alt="OpenViking" src="https://raw.githubusercontent.com/volcengine/OpenViking/f5b6043d29406ec8102402868745bdc879e48f90/docs/images/readme-logo-light.png" width="300" height="56">
</picture>
</a>
-### OpenViking: AIエージェントのためのコンテキストデータベース
+### AIエージェントのためのコンテキストデータベース
-[English](README.md) / [中文](README_CN.md) / 日本語
+[English](../../README.md) / [中文](README_CN.md) / 日本語
-<a href="https://www.openviking.ai">Webサイト</a> · <a href="https://openviking.ai/studio">ライブデモ</a> · <a href="https://github.com/volcengine/OpenViking">GitHub</a> · <a href="https://github.com/volcengine/OpenViking/issues">Issues</a> · <a href="https://docs.openviking.ai/">ドキュメント</a>
+<a href="https://www.openviking.ai">Webサイト</a> · <a href="https://openviking.ai/studio">ライブデモ</a> · <a href="https://github.com/volcengine/OpenViking">GitHub</a> · <a href="https://github.com/volcengine/OpenViking/issues">Issues</a> · <a href="https://docs.openviking.ai/">ドキュメント</a> · <a href="https://blog.openviking.ai/">ブログ</a>
<p>
<a href="https://github.com/volcengine/OpenViking/releases"><img src="https://img.shields.io/github/v/release/volcengine/OpenViking?color=369eff&labelColor=black&logo=github&style=flat-square" alt="release"></a>
@@ -26,10 +27,10 @@
</p>
<p>
- <a href="https://docs.openviking.ai/en/about/01-about-us#lark-group"><img src="docs/images/community/lark.svg" width="18" height="18" alt="Lark">&nbsp;Lark</a> ·
- <a href="https://docs.openviking.ai/en/about/01-about-us#wechat-group"><img src="docs/images/community/wechat.svg" width="18" height="18" alt="WeChat">&nbsp;WeChat</a> ·
- <a href="https://discord.com/invite/eHvx8E9XF3"><img src="docs/images/community/discord.svg" width="18" height="18" alt="Discord">&nbsp;Discord</a> ·
- <a href="https://x.com/openvikingai"><picture><source media="(prefers-color-scheme: dark)" srcset="docs/images/community/x-dark.svg"><img src="docs/images/community/x.svg" width="16" height="16" alt="X"></picture>&nbsp;X</a>
+ <a href="https://docs.openviking.ai/en/about/01-about-us#lark-group"><img src="../images/community/lark.svg" width="18" height="18" alt="Lark">&nbsp;Lark</a> ·
+ <a href="https://docs.openviking.ai/en/about/01-about-us#wechat-group"><img src="../images/community/wechat.svg" width="18" height="18" alt="WeChat">&nbsp;WeChat</a> ·
+ <a href="https://discord.com/invite/eHvx8E9XF3"><img src="../images/community/discord.svg" width="18" height="18" alt="Discord">&nbsp;Discord</a> ·
+ <a href="https://x.com/openvikingai"><picture><source media="(prefers-color-scheme: dark)" srcset="../images/community/x-dark.svg"><img src="../images/community/x.svg" width="16" height="16" alt="X"></picture>&nbsp;X</a>
</p>
<a href="https://trendshift.io/repositories/19668" target="_blank"><img src="https://trendshift.io/api/badge/repositories/19668" alt="volcengine%2FOpenViking | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a>
@@ -46,12 +47,12 @@ OpenVikingは、AIエージェントのためのオープンソースのコン
<a href="https://openviking.ai/studio" target="_blank" rel="noopener noreferrer">
<picture>
- <source media="(prefers-color-scheme: dark)" srcset="docs/images/studio-playground-dark.png">
- <img src="docs/images/studio-playground.png" alt="OpenViking Studio:コンテキストの閲覧と意味検索">
+ <source media="(prefers-color-scheme: dark)" srcset="../images/studio-playground-dark.png">
+ <img src="../images/studio-playground.png" alt="OpenViking Studio:コンテキストの閲覧と意味検索">
</picture>
</a>
-[OpenViking Studioを試す](https://openviking.ai/studio)。ブラウザから利用でき、インストールは不要です。 [Web Studioを自分の環境にデプロイ](web-studio/README.md)。
+[OpenViking Studioを試す](https://openviking.ai/studio)。ブラウザから利用でき、インストールは不要です。 [Web Studioを自分の環境にデプロイ](../../web-studio/README.md)。
## OpenVikingを選ぶ理由
@@ -107,13 +108,13 @@ viking://resources/my_project/
## 実証データ
-OpenViking 0.3.22 は、長い会話でのユーザーメモリ(LoCoMo)と複数ターンのエージェントタスク(tau2-bench)で評価されています。ナレッジベースQAを含む完全な結果と実験設定は[ベンチマークレポート](https://blog.openviking.ai/post/openviking-benchmark-results/)を、再現用スクリプトは [./benchmark](./benchmark) を参照してください。
+OpenViking 0.3.22 は、長い会話でのユーザーメモリ(LoCoMo)と複数ターンのエージェントタスク(tau2-bench)で評価されています。ナレッジベースQAを含む完全な結果と実験設定は[ベンチマークレポート](https://blog.openviking.ai/post/openviking-benchmark-results/)を、再現用スクリプトは [./benchmark](../../benchmark) を参照してください。
メモリ評価では、VLM に [Doubao 2.0 Pro](https://console.volcengine.com/ark/region:cn-beijing/model/detail?Id=doubao-seed-2-0-pro)、Embedding モデルに [Doubao-embedding-vision-251215](https://console.volcengine.com/ark/region:cn-beijing/model/detail?Id=doubao-embedding-vision) を使用しました。
<picture>
- <source media="(prefers-color-scheme: dark)" srcset="docs/images/benchmark-dark.svg">
- <img alt="Benchmark results. LoCoMo accuracy: OpenClaw 24.20% native vs 82.08% with OpenViking; Hermes 33.38% vs 82.86%; Claude Code 57.21% vs 80.32%. tau2-bench task success: Retail 70.94% vs 77.81%; Airline 54.38% vs 66.25%." src="docs/images/benchmark-light.svg">
+ <source media="(prefers-color-scheme: dark)" srcset="../images/benchmark-dark.svg">
+ <img alt="Benchmark results. LoCoMo accuracy: OpenClaw 24.20% native vs 82.08% with OpenViking; Hermes 33.38% vs 82.86%; Claude Code 57.21% vs 80.32%. tau2-bench task success: Retail 70.94% vs 77.81%; Airline 54.38% vs 66.25%." src="../images/benchmark-light.svg">
</picture>
- **ユーザーメモリ(LoCoMo)**: OpenViking を接続すると、3つのエージェント統合すべてで精度が 80–83% に達します(ネイティブメモリでは 24–57%)。同時に入力 token は 34.3–91.0%、クエリレイテンシは 58.45–66.10% 削減されます。
@@ -180,7 +181,7 @@ ov grep "openviking" --uri viking://resources/volcengine/OpenViking/docs/en
`ov find` は一致したコンテキストと URI を返します。クライアント設定(`ov config`)、CLI の単体インストール、インデックス管理は [CLI セットアップ](https://docs.openviking.ai/en/getting-started/05-cli-setup)を参照してください。
-独自のアプリには [Python](sdk/python/README.md)、[Go](sdk/go/README.md)、[TypeScript](sdk/typescript/README.md) SDK、または [HTTP API](https://docs.openviking.ai/en/api/01-overview) を使えます。
+独自のアプリには [Python](../../sdk/python/README.md)、[Go](../../sdk/go/README.md)、[TypeScript](../../sdk/typescript/README.md) SDK、または [HTTP API](https://docs.openviking.ai/en/api/01-overview) を使えます。
## エージェントと組み合わせて使う
@@ -247,27 +248,27 @@ Codex は初回起動時に `Hooks need review` で止まるので、`Trust all
<tbody>
<tr>
<td align="center" valign="bottom" width="16%">
-<a href="https://docs.openviking.ai/en/agent-integrations/02-claude-code"><img src="docs/images/integrations/logos/claude-code.png" width="32" height="32" alt=""><br><strong>Claude</strong></a><br>
+<a href="https://docs.openviking.ai/en/agent-integrations/02-claude-code"><img src="../images/integrations/logos/claude-code.png" width="32" height="32" alt=""><br><strong>Claude</strong></a><br>
<sub>Hooks&nbsp;+&nbsp;MCP</sub>
</td>
<td align="center" valign="bottom" width="16%">
-<a href="https://docs.openviking.ai/en/agent-integrations/04-codex"><picture><source media="(prefers-color-scheme: dark)" srcset="docs/images/integrations/logos/openai-dark.svg"><img src="docs/images/integrations/logos/openai.svg" width="32" height="32" alt=""></picture><br><strong>Codex</strong></a><br>
+<a href="https://docs.openviking.ai/en/agent-integrations/04-codex"><picture><source media="(prefers-color-scheme: dark)" srcset="../images/integrations/logos/openai-dark.svg"><img src="../images/integrations/logos/openai.svg" width="32" height="32" alt=""></picture><br><strong>Codex</strong></a><br>
<sub>Hooks&nbsp;+&nbsp;MCP</sub>
</td>
<td align="center" valign="bottom" width="16%">
-<a href="https://docs.openviking.ai/en/agent-integrations/12-cursor"><img src="docs/images/integrations/logos/cursor.png" width="32" height="32" alt=""><br><strong>Cursor</strong></a><br>
+<a href="https://docs.openviking.ai/en/agent-integrations/12-cursor"><img src="../images/integrations/logos/cursor.png" width="32" height="32" alt=""><br><strong>Cursor</strong></a><br>
<sub>Hooks&nbsp;+&nbsp;MCP</sub>
</td>
<td align="center" valign="bottom" width="16%">
-<a href="https://docs.openviking.ai/en/agent-integrations/13-trae"><img src="docs/images/integrations/logos/trae.png" width="32" height="32" alt=""><br><strong>TRAE</strong></a><br>
+<a href="https://docs.openviking.ai/en/agent-integrations/13-trae"><img src="../images/integrations/logos/trae.png" width="32" height="32" alt=""><br><strong>TRAE</strong></a><br>
<sub>Hooks&nbsp;+&nbsp;MCP</sub>
</td>
<td align="center" valign="bottom" width="16%">
-<a href="https://docs.openviking.ai/en/agent-integrations/03-openclaw"><img src="docs/images/integrations/logos/openclaw.png" width="32" height="32" alt=""><br><strong>OpenClaw</strong></a><br>
+<a href="https://docs.openviking.ai/en/agent-integrations/03-openclaw"><img src="../images/integrations/logos/openclaw.png" width="32" height="32" alt=""><br><strong>OpenClaw</strong></a><br>
<sub>コンテキストエンジン</sub>
</td>
<td align="center" valign="bottom" width="16%">
-<a href="https://docs.openviking.ai/en/agent-integrations/05-hermes"><img src="docs/images/integrations/logos/hermes-agent.png" width="32" height="32" alt=""><br><strong>Hermes</strong></a><br>
+<a href="https://docs.openviking.ai/en/agent-integrations/05-hermes"><img src="../images/integrations/logos/hermes-agent.png" width="32" height="32" alt=""><br><strong>Hermes</strong></a><br>
<sub>内蔵メモリ</sub>
</td>
</tr>
@@ -275,27 +276,27 @@ Codex は初回起動時に `Hooks need review` で止まるので、`Trust all
<tbody>
<tr>
<td align="center" valign="bottom" width="16%">
-<a href="https://docs.openviking.ai/en/agent-integrations/10-opencode"><img src="docs/images/integrations/logos/opencode.png" width="32" height="32" alt=""><br><strong>OpenCode</strong></a><br>
+<a href="https://docs.openviking.ai/en/agent-integrations/10-opencode"><img src="../images/integrations/logos/opencode.png" width="32" height="32" alt=""><br><strong>OpenCode</strong></a><br>
<sub>Plugin&nbsp;+&nbsp;MCP</sub>
</td>
<td align="center" valign="bottom" width="16%">
-<a href="https://docs.openviking.ai/en/agent-integrations/11-pi"><picture><source media="(prefers-color-scheme: dark)" srcset="docs/images/integrations/logos/pi-dark.svg"><img src="docs/images/integrations/logos/pi.svg" width="32" height="32" alt=""></picture><br><strong>pi</strong></a><br>
+<a href="https://docs.openviking.ai/en/agent-integrations/11-pi"><picture><source media="(prefers-color-scheme: dark)" srcset="../images/integrations/logos/pi-dark.svg"><img src="../images/integrations/logos/pi.svg" width="32" height="32" alt=""></picture><br><strong>pi</strong></a><br>
<sub>ネイティブ拡張</sub>
</td>
<td align="center" valign="bottom" width="16%">
-<a href="docs/images/agents/en/deerflow-memory-manager.md"><picture><source media="(prefers-color-scheme: dark)" srcset="docs/images/integrations/logos/deerflow-dark.svg"><img src="docs/images/integrations/logos/deerflow.svg" width="32" height="32" alt=""></picture><br><strong>DeerFlow</strong></a><br>
+<a href="../images/agents/en/deerflow-memory-manager.md"><picture><source media="(prefers-color-scheme: dark)" srcset="../images/integrations/logos/deerflow-dark.svg"><img src="../images/integrations/logos/deerflow.svg" width="32" height="32" alt=""></picture><br><strong>DeerFlow</strong></a><br>
<sub>Plugin&nbsp;+&nbsp;MCP</sub>
</td>
<td align="center" valign="bottom" width="16%">
-<a href="https://docs.openviking.ai/en/agent-integrations/17-dsh"><picture><source media="(prefers-color-scheme: dark)" srcset="docs/images/integrations/logos/dsh-dark.svg"><img src="docs/images/integrations/logos/dsh.svg" width="32" height="32" alt=""></picture><br><strong>DSH</strong></a><br>
+<a href="https://docs.openviking.ai/en/agent-integrations/17-dsh"><picture><source media="(prefers-color-scheme: dark)" srcset="../images/integrations/logos/dsh-dark.svg"><img src="../images/integrations/logos/dsh.svg" width="32" height="32" alt=""></picture><br><strong>DSH</strong></a><br>
<sub>Plugin&nbsp;+&nbsp;MCP</sub>
</td>
<td align="center" valign="bottom" width="16%">
-<a href="docs/images/agents/en/doubao-work.md"><img src="docs/images/integrations/logos/doubao-work.png" width="32" height="32" alt=""><br><strong>Doubao&nbsp;Work</strong></a><br>
+<a href="../images/agents/en/doubao-work.md"><img src="../images/integrations/logos/doubao-work.png" width="32" height="32" alt=""><br><strong>Doubao&nbsp;Work</strong></a><br>
<sub>コネクタ</sub>
</td>
<td align="center" valign="bottom" width="16%">
-<a href="https://docs.openviking.ai/en/agent-integrations/07-langchain-langgraph"><img src="docs/images/integrations/logos/langchain.svg" width="32" height="32" alt=""><br><strong>LangChain</strong></a><br>
+<a href="https://docs.openviking.ai/en/agent-integrations/07-langchain-langgraph"><img src="../images/integrations/logos/langchain.svg" width="32" height="32" alt=""><br><strong>LangChain</strong></a><br>
<sub>ツール&nbsp;+&nbsp;ストア</sub>
</td>
</tr>
@@ -307,10 +308,10 @@ Codex は初回起動時に `Hooks need review` で止まるので、`Trust all
<table>
<tr>
<td align="center" valign="bottom" width="50%">
-<a href="https://docs.openviking.ai/en/agent-integrations/15-agent-plugins"><img src="docs/images/integrations/logos/agent-plugins.svg" width="32" height="32" alt=""><br><strong>Agent&nbsp;Plugins&nbsp;1.0</strong></a>
+<a href="https://docs.openviking.ai/en/agent-integrations/15-agent-plugins"><img src="../images/integrations/logos/agent-plugins.svg" width="32" height="32" alt=""><br><strong>Agent&nbsp;Plugins&nbsp;1.0</strong></a>
</td>
<td align="center" valign="bottom" width="50%">
-<a href="https://docs.openviking.ai/en/agent-integrations/06-mcp-clients"><img src="docs/images/integrations/logos/mcp.svg" width="32" height="32" alt=""><br><strong>MCP&nbsp;ク&#8288;ラ&#8288;イ&#8288;ア&#8288;ン&#8288;ト</strong></a>
+<a href="https://docs.openviking.ai/en/agent-integrations/06-mcp-clients"><img src="../images/integrations/logos/mcp.svg" width="32" height="32" alt=""><br><strong>MCP&nbsp;ク&#8288;ラ&#8288;イ&#8288;ア&#8288;ン&#8288;ト</strong></a>
</td>
</tr>
</table>
@@ -341,7 +342,7 @@ ov chat # 別のターミナルで実行
## 本番環境へのデプロイ
-オープンソースのサーバーは [AGPLv3](LICENSE) のもとで自分の環境にデプロイでき、アクティベーションキーは不要です。[サーバー設定](https://docs.openviking.ai/en/getting-started/03-quickstart-server) · [Docker とデプロイのガイド](https://docs.openviking.ai/en/guides/03-deployment)
+オープンソースのサーバーは [AGPLv3](../../LICENSE) のもとで自分の環境にデプロイでき、アクティベーションキーは不要です。[サーバー設定](https://docs.openviking.ai/en/getting-started/03-quickstart-server) · [Docker とデプロイのガイド](https://docs.openviking.ai/en/guides/03-deployment)
サーバーは[アカウントとユーザーの分離](https://docs.openviking.ai/en/concepts/11-multi-tenant)に対応し、[リソース ACL](https://docs.openviking.ai/en/concepts/15-acl)を必要に応じて有効にできます。localhost 以外から接続する前に[認証](https://docs.openviking.ai/en/guides/04-authentication)を設定してください。
@@ -351,7 +352,7 @@ ov chat # 別のターミナルで実行
<tr>
<td width="50%" valign="top">
-<img src="docs/images/commercial-saas.png" alt="マネージド SaaS 版" width="100%" />
+<img src="../images/commercial-saas.png" alt="マネージド SaaS 版" width="100%" />
<h3>☁️ マネージド SaaS 版</h3>
<p><a href="https://www.volcengine.com/product/openviking-service">Volcano Engine</a> がホスティングと運用を担当します。個人向けと企業向けのプラン、オープンソース環境からの移行ツールを提供します。プランと制限は<a href="https://docs.volcengine.com/docs/84313/2374478">サービス文書</a>を参照してください。中国以外でのホスティングは <a href="https://www.byteplus.com">BytePlus</a> で予定されています。</p>
@@ -359,7 +360,7 @@ ov chat # 別のターミナルで実行
</td>
<td width="50%" valign="top">
-<img src="docs/images/commercial-self-hosted.png" alt="プライベートデプロイ版" width="100%" />
+<img src="../images/commercial-self-hosted.png" alt="プライベートデプロイ版" width="100%" />
<h3>🏢 プライベートデプロイ版</h3>
<p>自社のクラウドアカウント / VPC(BYOC)、またはオフライン環境にデプロイできます。分散デプロイと公式サポートを提供し、ライセンスキーで有効化します。<a href="https://docs.google.com/forms/d/e/1FAIpQLScQqwsm7fvKdjtNiW5rWNXJjoHPtedVzLsKSMJgObtsj2_udA/viewform">チームに問い合わせる</a>。</p>
@@ -405,7 +406,7 @@ ov chat # 別のターミナルで実行
- **ドキュメント**: [docs.openviking.ai](https://docs.openviking.ai/) · [FAQ](https://docs.openviking.ai/en/faq/faq)
- **ブログ**: [blog.openviking.ai](https://blog.openviking.ai/)
- **チーム**: [About us](https://docs.openviking.ai/en/about/01-about-us)
-- **チャット**: <a href="https://docs.openviking.ai/en/about/01-about-us#lark-group"><img src="docs/images/community/lark.svg" width="18" height="18" alt="Lark">&nbsp;Lark</a> · <a href="https://docs.openviking.ai/en/about/01-about-us#wechat-group"><img src="docs/images/community/wechat.svg" width="18" height="18" alt="WeChat">&nbsp;WeChat</a> · <a href="https://discord.com/invite/eHvx8E9XF3"><img src="docs/images/community/discord.svg" width="18" height="18" alt="Discord">&nbsp;Discord</a> · <a href="https://x.com/openvikingai"><picture><source media="(prefers-color-scheme: dark)" srcset="docs/images/community/x-dark.svg"><img src="docs/images/community/x.svg" width="16" height="16" alt="X"></picture>&nbsp;X</a>
+- **チャット**: <a href="https://docs.openviking.ai/en/about/01-about-us#lark-group"><img src="../images/community/lark.svg" width="18" height="18" alt="Lark">&nbsp;Lark</a> · <a href="https://docs.openviking.ai/en/about/01-about-us#wechat-group"><img src="../images/community/wechat.svg" width="18" height="18" alt="WeChat">&nbsp;WeChat</a> · <a href="https://discord.com/invite/eHvx8E9XF3"><img src="../images/community/discord.svg" width="18" height="18" alt="Discord">&nbsp;Discord</a> · <a href="https://x.com/openvikingai"><picture><source media="(prefers-color-scheme: dark)" srcset="../images/community/x-dark.svg"><img src="../images/community/x.svg" width="16" height="16" alt="X"></picture>&nbsp;X</a>
- **コントリビュート**: バグ修正も新機能も歓迎します — [CONTRIBUTING_JA.md](CONTRIBUTING_JA.md) を参照してください
<a href="https://github.com/volcengine/OpenViking/graphs/contributors">
@@ -414,13 +415,13 @@ ov chat # 別のターミナルで実行
## セキュリティとプライバシー
-脆弱性の報告方法とサポート対象バージョンについては、[SECURITY.md](SECURITY.md) を参照してください
+脆弱性の報告方法とサポート対象バージョンについては、[SECURITY.md](../../SECURITY.md) を参照してください
## ライセンス
OpenViking プロジェクトは、コンポーネントごとに異なるライセンスを使用しています:
-- **メインプロジェクト**: AGPLv3 - 詳細は [LICENSE](./LICENSE) ファイルを参照してください
-- **crates/ov\_cli**: Apache 2.0 - 詳細は [LICENSE](./crates/LICENSE) を参照してください
-- **examples**: Apache 2.0 - 詳細は [LICENSE](./examples/LICENSE) を参照してください。`examples/hermes-plugin` の Hermes プラグインは元の [MIT ライセンス](./examples/hermes-plugin/LICENSE) を保持します。
+- **メインプロジェクト**: AGPLv3 - 詳細は [LICENSE](../../LICENSE) ファイルを参照してください
+- **crates/ov\_cli**: Apache 2.0 - 詳細は [LICENSE](../../crates/LICENSE) を参照してください
+- **examples**: Apache 2.0 - 詳細は [LICENSE](../../examples/LICENSE) を参照してください。`examples/hermes-plugin` の Hermes プラグインは元の [MIT ライセンス](../../examples/hermes-plugin/LICENSE) を保持します。
- **third\_party**: 各サードパーティプロジェクトの元のライセンス
diff --git a/RELEASE.md b/docs/repository/RELEASE.md
similarity index 100%
rename from RELEASE.md
rename to docs/repository/RELEASE.md
diff --git a/RELEASE_CN.md b/docs/repository/RELEASE_CN.md
similarity index 100%
rename from RELEASE_CN.md
rename to docs/repository/RELEASE_CN.md
diff --git a/docs/zh/about/01-about-us.md b/docs/zh/about/01-about-us.md
index 51efe1293..b73de2e64 100644
--- a/docs/zh/about/01-about-us.md
+++ b/docs/zh/about/01-about-us.md
@@ -80,7 +80,7 @@ OpenViking 自启动起就与高校和研究机构合作,共同探索面向 AI
开源治理委员会负责技术路线、版本与功能优先级、核心架构和兼容性评审、工程规范、贡献者协作,以及相关项目的集成。成员包括 Maojia Sheng([@MaojiaSheng](https://github.com/MaojiaSheng))、Haojie Qin([@qin-ctx](https://github.com/qin-ctx))、Jiahui Zhou([@zhoujh01](https://github.com/zhoujh01))、Zhiheng Liu([@ZaynJarvis](https://github.com/ZaynJarvis))。符合条件的社区贡献者可以通过后续的提名与选举程序加入委员会。
-具体模块的协作入口和近期活跃评审者见[贡献指南](https://github.com/volcengine/OpenViking/blob/main/CONTRIBUTING_CN.md)。
+具体模块的协作入口和近期活跃评审者见[贡献指南](https://github.com/volcengine/OpenViking/blob/main/docs/repository/CONTRIBUTING_CN.md)。
功能建议和问题在 [GitHub Issues](https://github.com/volcengine/OpenViking/issues) 讨论,代码与文档变更通过 Pull Request 评审。涉及公开接口、数据存储、权限边界或跨模块架构的改动,请先说明当前行为、目标行为、请求或配置示例,以及兼容性影响,再开始实现。
@@ -107,11 +107,11 @@ OpenViking 自启动起就与高校和研究机构合作,共同探索面向 AI
### 参与方式
- **报告问题或提建议**:在 [Issues](https://github.com/volcengine/OpenViking/issues) 提供场景、版本和复现步骤。
-- **改代码或文档**:阅读[贡献指南](https://github.com/volcengine/OpenViking/blob/main/CONTRIBUTING_CN.md),提交实现、测试、文档或翻译。
+- **改代码或文档**:阅读[贡献指南](https://github.com/volcengine/OpenViking/blob/main/docs/repository/CONTRIBUTING_CN.md),提交实现、测试、文档或翻译。
- **开发集成**:为 Agent 工具或框架添加插件,参考[插件开发指南](../agent-integrations/18-plugin-development.md)。
- **分享经验**:在社区分享使用案例、排障过程,或帮助其他用户解决问题。
-Issue 和 PR 需要提供的信息见[贡献指南](https://github.com/volcengine/OpenViking/blob/main/CONTRIBUTING_CN.md)。
+Issue 和 PR 需要提供的信息见[贡献指南](https://github.com/volcengine/OpenViking/blob/main/docs/repository/CONTRIBUTING_CN.md)。
## 讨论与协作机制
diff --git a/docs/zh/about/03-roadmap.md b/docs/zh/about/03-roadmap.md
index 3719a5681..fca07963a 100644
--- a/docs/zh/about/03-roadmap.md
+++ b/docs/zh/about/03-roadmap.md
@@ -16,4 +16,4 @@
- 继续完善分布式存储。
- 接入更多 Agent 框架。
-提案与范围讨论见 [GitHub issues](https://github.com/volcengine/OpenViking/issues),参与开发见[贡献指南](https://github.com/volcengine/OpenViking/blob/main/CONTRIBUTING_CN.md)。
+提案与范围讨论见 [GitHub issues](https://github.com/volcengine/OpenViking/issues),参与开发见[贡献指南](https://github.com/volcengine/OpenViking/blob/main/docs/repository/CONTRIBUTING_CN.md)。
diff --git a/docs/zh/agent-integrations/18-plugin-development.md b/docs/zh/agent-integrations/18-plugin-development.md
index 8330466e1..b2af15895 100644
--- a/docs/zh/agent-integrations/18-plugin-development.md
+++ b/docs/zh/agent-integrations/18-plugin-development.md
@@ -46,7 +46,7 @@ Task: <describe the plugin addition, fix, or maintenance change>
5. **交付方式决定生成时机**。用户直接加载仓库目录时,目录必须已经完整;用户安装构建产物时,在打包前生成依赖。不为减少 diff 破坏安装,也不为方便开发提交不需要的生成物。
6. **每次抽象都减少维护点**。新接口应让后续修复少改一个地方。若只是多了一层转发、更多布尔参数或第二套配置表,应重新考虑。
-这些原则与仓库[贡献指南的职责与设计要求](https://github.com/volcengine/OpenViking/blob/main/CONTRIBUTING_CN.md#职责与设计)一致。衡量改动是否合理,要看一个新维护者能否沿调用关系找到规则、解释失败、完成交付。代码行数和文件数量只是结果。
+这些原则与仓库[贡献指南的职责与设计要求](https://github.com/volcengine/OpenViking/blob/main/docs/repository/CONTRIBUTING_CN.md#职责与设计)一致。衡量改动是否合理,要看一个新维护者能否沿调用关系找到规则、解释失败、完成交付。代码行数和文件数量只是结果。
## 2. 接入前先确定宿主契约
diff --git a/docs/zh/faq/faq.md b/docs/zh/faq/faq.md
index d2e0701ba..1afc3efd3 100644
--- a/docs/zh/faq/faq.md
+++ b/docs/zh/faq/faq.md
@@ -82,7 +82,7 @@ OpenViking 通过 Rust 绑定(`ragfs_python` / `RAGFSBindingClient`)在 Pyth
### 遇到 "AGFS binding library not found" 错误怎么办?
-这通常表示 RAGFS 共享库缺失或无法加载。先检查 Python 版本和平台是否有对应的预编译 wheel,并尝试重新安装。只有平台缺少 wheel 或需要修改源码时才[从源码构建](https://github.com/volcengine/OpenViking/blob/main/CONTRIBUTING_CN.md),届时需准备原生编译工具链。
+这通常表示 RAGFS 共享库缺失或无法加载。先检查 Python 版本和平台是否有对应的预编译 wheel,并尝试重新安装。只有平台缺少 wheel 或需要修改源码时才[从源码构建](https://github.com/volcengine/OpenViking/blob/main/docs/repository/CONTRIBUTING_CN.md),届时需准备原生编译工具链。
### 如何安装 OpenViking?
diff --git a/docs/zh/guides/20-private-deployment.md b/docs/zh/guides/20-private-deployment.md
index 41163c82e..af239d48b 100644
--- a/docs/zh/guides/20-private-deployment.md
+++ b/docs/zh/guides/20-private-deployment.md
@@ -4,13 +4,13 @@ description: 使用 Viking 私有交付包,从配置预览、VikingDB 部署
# 企业私有化部署
-<p><VPButton text="联系我们获取部署物料" href="https://github.com/volcengine/OpenViking/blob/main/README_CN.md#%E5%95%86%E4%B8%9A%E7%89%88%E6%9C%AC" /></p>
+<p><VPButton text="联系我们获取部署物料" href="https://github.com/volcengine/OpenViking/blob/main/docs/repository/README_CN.md#%E5%95%86%E4%B8%9A%E7%89%88%E6%9C%AC" /></p>
通过部署物料,在自己的 Kubernetes 集群中安装 VikingDB 和 OpenViking。开始前,请先完成[部署前检查](19-deployment-checklist.md)。Python、Docker 和开源 Helm 安装见[服务端部署](03-deployment.md)。
## 1. 获取物料并同步镜像
-部署物料需要先申请:在 [README 商业版本](https://github.com/volcengine/OpenViking/blob/main/README_CN.md#%E5%95%86%E4%B8%9A%E7%89%88%E6%9C%AC)登记邮箱,审核通过后,安装包下载链接和试用 License 会发到登记邮箱。
+部署物料需要先申请:在 [README 商业版本](https://github.com/volcengine/OpenViking/blob/main/docs/repository/README_CN.md#%E5%95%86%E4%B8%9A%E7%89%88%E6%9C%AC)登记邮箱,审核通过后,安装包下载链接和试用 License 会发到登记邮箱。
解压后核对 `bin/ovadmin`、`viking-docs/` 与交付清单。安装包只含 CLI 和文档,运行镜像要按 `vikinglist` 另外下载,再导入客户 Registry。镜像已同步到 Registry 时跳过本节。
diff --git a/examples/basic-usage/README_CN.md b/examples/basic-usage/README_CN.md
index f632d879e..69f3b9f55 100644
--- a/examples/basic-usage/README_CN.md
+++ b/examples/basic-usage/README_CN.md
@@ -231,7 +231,7 @@ memories = client.find(
}
```
-你也可以使用火山引擎、Azure OpenAI 等提供商。当前配置示例请以主 [README](../../README_CN.md) 和 [配置指南](../../docs/zh/guides/01-configuration.md) 为准。
+你也可以使用火山引擎、Azure OpenAI 等提供商。当前配置示例请以主 [README](../../docs/repository/README_CN.md) 和 [配置指南](../../docs/zh/guides/01-configuration.md) 为准。
## 推荐下一步
diff --git a/examples/dsh-memory-plugin/config.mjs b/examples/dsh-memory-plugin/config.mjs
index 7448d3c48..d099f626c 100644
--- a/examples/dsh-memory-plugin/config.mjs
+++ b/examples/dsh-memory-plugin/config.mjs
@@ -1,7 +1,7 @@
import { buildPluginConfig } from "./shared/plugin-config.mjs";
import { loadCredentialFiles } from "./shared/credentials.mjs";
-export const PLUGIN_VERSION = "0.5.12";
+export const PLUGIN_VERSION = "0.5.13";
/**
* Namespace for the bridged OpenViking MCP tools. DSH publishes every MCP tool
diff --git a/examples/dsh-memory-plugin/icon.svg b/examples/dsh-memory-plugin/icon.svg
index dfddbd308..705ad35ef 100644
--- a/examples/dsh-memory-plugin/icon.svg
+++ b/examples/dsh-memory-plugin/icon.svg
@@ -1,17 +1,4 @@
-<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" role="img" aria-label="OpenViking" focusable="false">
- <title>OpenViking</title>
- <style>
- /* Monochrome mark. The plugin card renders this file as an image document,
- which cannot read the page palette, so the two inks are declared here and
- the scheme flip comes from the only signal an image document gets:
- prefers-color-scheme. The base fill attribute keeps the black ink in
- renderers that lack that query, and the class is named after the product
- to stay unique if this file is ever inlined. */
- @media (prefers-color-scheme: dark) {
- .openviking-mark { fill: #ffffff; }
- }
- </style>
- <path class="openviking-mark" fill="#000000" d="M21.9136 11.2875C21.8311 15.6708 18.953 19.691 14.5292 21.0217C10.1055 22.3524 5.48691 20.587 3 16.9758L6.35328 15.9668C8.52232 18.6563 12.1802 19.9123 15.6932 18.8558C19.2062 17.7993 21.5646 14.7335 21.8903 11.2938L21.9136 11.2867V11.2875Z"/>
- <path class="openviking-mark" fill="#000000" d="M11.9754 2.26476C14.2745 3.4155 19.0247 7.27598 19.1416 14.5217L9.68011 17.3709C10.3938 16.4998 11.0303 15.5158 11.5546 14.4446L15.4019 13.2751C16.6438 8.11275 14.2504 4.18838 11.9941 2.3115C11.9878 2.29592 11.9816 2.28034 11.9754 2.26398V2.26476ZM11.9941 2.31228C13.7548 6.71269 13.2274 11.0251 11.5546 14.4446L8.98047 15.2268C12.4085 10.0457 12.4865 5.64375 11.9699 2.29125C11.9785 2.29826 11.9863 2.30527 11.9941 2.3115V2.31228Z"/>
- <path class="openviking-mark" fill="#000000" d="M11.9909 2.31144C13.7517 6.71185 13.2243 11.0242 11.5515 14.4437L8.97656 15.2259C12.4046 10.0449 12.4826 5.64291 11.966 2.29041C11.9746 2.29742 11.9824 2.30443 11.9902 2.31066L11.9909 2.31144Z"/>
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="#07090D">
+ <style>@media (prefers-color-scheme: dark) { .openviking-mark { fill: #F4F5F3; } }</style>
+ <g class="openviking-mark"><polygon points="2,21 6,21 18,3"/><polygon points="9,21 21,3 21,21"/></g>
</svg>
diff --git a/examples/dsh-memory-plugin/package-lock.json b/examples/dsh-memory-plugin/package-lock.json
index ab77b2baa..dfd9928a5 100644
--- a/examples/dsh-memory-plugin/package-lock.json
+++ b/examples/dsh-memory-plugin/package-lock.json
@@ -1,12 +1,12 @@
{
"name": "@openviking/dsh-memory-plugin",
- "version": "0.5.12",
+ "version": "0.5.13",
"lockfileVersion": 3,
"requires": true,
"packages": {
"": {
"name": "@openviking/dsh-memory-plugin",
- "version": "0.5.12",
+ "version": "0.5.13",
"license": "Apache-2.0",
"devDependencies": {
"@deepseek-ai/dsh-llm": "0.1.0-rc.6",
diff --git a/examples/dsh-memory-plugin/package.json b/examples/dsh-memory-plugin/package.json
index b22d55c08..0b09e10aa 100644
--- a/examples/dsh-memory-plugin/package.json
+++ b/examples/dsh-memory-plugin/package.json
@@ -1,6 +1,6 @@
{
"name": "@openviking/dsh-memory-plugin",
- "version": "0.5.12",
+ "version": "0.5.13",
"description": "OpenViking memory and context bundle for DeepSeek Harness",
"icon": "./icon.svg",
"type": "module",
diff --git a/openviking/server/static/apple-touch-icon.png b/openviking/server/static/apple-touch-icon.png
index 5c8385566..572a71d10 100644
Binary files a/openviking/server/static/apple-touch-icon.png and b/openviking/server/static/apple-touch-icon.png differ
diff --git a/openviking/server/static/favicon-32.png b/openviking/server/static/favicon-32.png
index 27c94520b..3accc2919 100644
Binary files a/openviking/server/static/favicon-32.png and b/openviking/server/static/favicon-32.png differ
diff --git a/openviking/server/static/favicon.ico b/openviking/server/static/favicon.ico
index 13eb46e09..025f2bf4e 100644
Binary files a/openviking/server/static/favicon.ico and b/openviking/server/static/favicon.ico differ
diff --git a/web-studio/CONTRIBUTING_CN.md b/web-studio/CONTRIBUTING_CN.md
index 9800d6c76..51eedfd2c 100644
--- a/web-studio/CONTRIBUTING_CN.md
+++ b/web-studio/CONTRIBUTING_CN.md
@@ -129,4 +129,4 @@ npm test -- <relevant-test-files>
## 相关文档
-- [OpenViking 贡献指南](../CONTRIBUTING_CN.md):仓库通用的贡献流程和要求。
+- [OpenViking 贡献指南](../docs/repository/CONTRIBUTING_CN.md):仓库通用的贡献流程和要求。
diff --git a/web-studio/index.html b/web-studio/index.html
index 00d396b44..f7231a678 100644
--- a/web-studio/index.html
+++ b/web-studio/index.html
@@ -2,6 +2,8 @@
<html lang="en">
<head>
<meta charset="UTF-8" />
+ <link rel="icon" type="image/x-icon" sizes="32x32" href="%BASE_URL%favicon.ico" />
+ <link rel="icon" type="image/svg+xml" href="%BASE_URL%favicon.svg" />
<link
rel="icon"
type="image/png"
diff --git a/web-studio/public/apple-touch-icon.png b/web-studio/public/apple-touch-icon.png
index 5c8385566..572a71d10 100644
Binary files a/web-studio/public/apple-touch-icon.png and b/web-studio/public/apple-touch-icon.png differ
diff --git a/web-studio/public/favicon-32.png b/web-studio/public/favicon-32.png
index 27c94520b..3accc2919 100644
Binary files a/web-studio/public/favicon-32.png and b/web-studio/public/favicon-32.png differ
diff --git a/web-studio/public/favicon.ico b/web-studio/public/favicon.ico
index 13eb46e09..025f2bf4e 100644
Binary files a/web-studio/public/favicon.ico and b/web-studio/public/favicon.ico differ
diff --git a/web-studio/public/favicon.svg b/web-studio/public/favicon.svg
new file mode 100644
index 000000000..c44b9d26b
--- /dev/null
+++ b/web-studio/public/favicon.svg
@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 16 16" width="16" height="16"><style>path,polygon{fill:#0A7C93}@media (prefers-color-scheme:dark){polygon{fill:#F4F5F3}}</style><polygon points="1,14 4,14 12,2"/><polygon points="6,14 14,2 14,14"/></svg>
diff --git a/web-studio/public/icon-192-maskable.png b/web-studio/public/icon-192-maskable.png
index 3beedf94d..8b1550fda 100644
Binary files a/web-studio/public/icon-192-maskable.png and b/web-studio/public/icon-192-maskable.png differ
diff --git a/web-studio/public/icon-192.png b/web-studio/public/icon-192.png
index 8e7eda5ca..a09a32d7f 100644
Binary files a/web-studio/public/icon-192.png and b/web-studio/public/icon-192.png differ
diff --git a/web-studio/public/icon-512-maskable.png b/web-studio/public/icon-512-maskable.png
index 2dd594c74..75241adf5 100644
Binary files a/web-studio/public/icon-512-maskable.png and b/web-studio/public/icon-512-maskable.png differ
diff --git a/web-studio/public/icon-512.png b/web-studio/public/icon-512.png
index fb9ea3329..799d1303e 100644
Binary files a/web-studio/public/icon-512.png and b/web-studio/public/icon-512.png differ
diff --git a/web-studio/public/ov-logo.png b/web-studio/public/ov-logo.png
index da45ce101..799d1303e 100644
Binary files a/web-studio/public/ov-logo.png and b/web-studio/public/ov-logo.png differ