Skip to content

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

fix(docs): add the ocean social preview (#5600)

Zayn Jarvisff7295af338a
diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts
index 7f3b0b104..87b517bd7 100644
--- a/docs/.vitepress/config.ts
+++ b/docs/.vitepress/config.ts
@@ -11,7 +11,8 @@ 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`
+// Version the filename so social crawlers do not reuse the previous artwork.
+const ogImageUrl = `${(process.env.DOCS_SITE_URL || 'https://docs.openviking.ai').replace(/\/$/, '')}${base}og-openviking-docs-392c2586.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;(() => {
@@ -204,11 +205,14 @@ export default defineConfig({
['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:type', content: 'image/png' }],
+ ['meta', { property: 'og:image:alt', content: 'OpenViking / docs — Guides and API reference for AI agent context.' }],
['meta', { property: 'og:image:width', content: '1200' }],
['meta', { property: 'og:image:height', content: '630' }],
['link', { rel: 'alternate', type: 'text/plain', title: 'LLM documentation index', href: `${base}llms.txt` }],
['meta', { name: 'twitter:card', content: 'summary_large_image' }],
['meta', { name: 'twitter:image', content: ogImageUrl }],
+ ['meta', { name: 'twitter:image:alt', content: 'OpenViking / docs — Guides and API reference for AI agent context.' }],
['script', {}, preferenceBootstrapScript],
['script', {}, languageBootstrapScript]
],
diff --git a/docs/.vitepress/social-preview.md b/docs/.vitepress/social-preview.md
new file mode 100644
index 000000000..e812621be
--- /dev/null
+++ b/docs/.vitepress/social-preview.md
@@ -0,0 +1,15 @@
+# Docs social preview
+
+Approved direction: midnight navy sea viewed from above, with branching silver foam and ivory text. Generated with the built-in imagegen tool. The approved homepage card is the edit reference; keep its ocean, sail and wordmark while changing the section label and copy.
+
+Asset: `docs/images/og-openviking-docs-392c2586.png`. Exported to 1200 × 630 PNG; the filename suffix is the first eight SHA-256 characters. Change the filename and all metadata references together when replacing the card. Keep previously published PNG URLs available for cached links.
+
+The generated PNG is the source artwork. It replaces the earlier turquoise SVG composition. Review logo, spelling and legibility before accepting any regeneration.
+
+## Final imagegen prompt
+
+```text
+Use case: text-localization. Edit the supplied approved OpenViking homepage social card into the requested sibling site's card.
+Preserve the same midnight navy ocean field, fine rough water texture, silvery branching foam, dark quiet left, composition, 1.905:1 landscape aspect ratio, sail-logo geometry and bold OpenViking wordmark. Do not redesign or regenerate a different art direction. Make only the specified typography edits. The new small lowercase section label follows the existing wordmark on the same baseline, separated by a slash. It must be smaller and lighter than OpenViking, in muted ivory, and fit without touching the brightest foam. Logo, wordmark and main description remain warm ivory; secondary description and domain remain muted pale gray. No card frame, no page chrome, no selection number, no new images. Accurate crisp English text.
+Section label: "/ docs". Replace "The context database for AI agents." with "Guides and API reference". Replace "Memory, resources, and skills in one place." with "Build with the context database for AI agents." Replace bottom-left "openviking.ai" with "docs.openviking.ai". Keep all copy left-aligned at the original positions and similar font sizes. The final result contains exactly the approved sail logo, "OpenViking", "/ docs", "Guides and API reference", "Build with the context database for AI agents.", and "docs.openviking.ai".
+```
diff --git a/docs/images/og-openviking-docs-392c2586.png b/docs/images/og-openviking-docs-392c2586.png
new file mode 100644
index 000000000..0e74ba724
Binary files /dev/null and b/docs/images/og-openviking-docs-392c2586.png differ