Skip to content

Add VitePress docs site and Pages deployment#1681

Merged
ZaynJarvis merged 4 commits intovolcengine:mainfrom
yufeng201:codex/vitepress-docs-pages
Apr 24, 2026
Merged

Add VitePress docs site and Pages deployment#1681
ZaynJarvis merged 4 commits intovolcengine:mainfrom
yufeng201:codex/vitepress-docs-pages

Conversation

@yufeng201
Copy link
Copy Markdown
Contributor

Description

Add a VitePress documentation site and deploy it to GitHub Pages during releases.

Related Issue

N/A

Type of Change

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Refactoring (no functional changes)
  • Performance improvement
  • Test update

Changes Made

  • Add a VitePress documentation site.
  • Deploy the docs site to GitHub Pages during releases.

Testing

  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • I have tested this on the following platforms:
    • Linux
    • macOS
    • Windows

Validated with npm run docs:build.

Checklist

  • My code follows the project's coding style
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • Any dependent changes have been merged and published

Screenshots (if applicable)

N/A

Additional Notes

N/A

@CLAassistant
Copy link
Copy Markdown

CLAassistant commented Apr 24, 2026

CLA assistant check
All committers have signed the CLA.

@github-actions
Copy link
Copy Markdown

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
🏅 Score: 85
🧪 No relevant tests
🔒 No security concerns identified
✅ No TODO sections
🔀 No multiple PR themes
⚡ Recommended focus areas for review

Missing Sidebar Entry

The Chinese locale sidebar configuration does not include the '/design/' path, so the design notes sidebar will not render when viewing the design section in Chinese.

sidebar: {
  '/zh/getting-started/': localizedGuideSidebarItems('zh'),
  '/zh/concepts/': localizedGuideSidebarItems('zh'),
  '/zh/guides/': localizedGuideSidebarItems('zh'),
  '/zh/api/': localizedReferenceSidebarItems('zh'),
  '/zh/about/': localizedAboutSidebarItems('zh')
},
Unclosed Details Tag

The closing

tag was removed, leaving an open
Details element which will cause invalid HTML and rendering issues.

<details>
<summary><b>PathStyle S3</b></summary>
Supports S3 storage in PathStyle mode, such as MinIO, SeaweedFS.
Unclosed Details Tag

The closing

tag was removed, leaving an open
Details element which will cause invalid HTML and rendering issues.

<details>
<summary><b>PathStyle S3</b></summary>
支持 PathStyle 模式的 S3 存储, 如 MinIO、SeaweedFS.

@github-actions
Copy link
Copy Markdown

PR Code Suggestions ✨

No code suggestions found for the PR.

@yufeng201 yufeng201 force-pushed the codex/vitepress-docs-pages branch from 33ec35d to fe46579 Compare April 24, 2026 09:45
@ZaynJarvis
Copy link
Copy Markdown
Collaborator

lgtm

@ZaynJarvis ZaynJarvis merged commit d796af4 into volcengine:main Apr 24, 2026
6 checks passed
@github-project-automation github-project-automation Bot moved this from Backlog to Done in OpenViking project Apr 24, 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.

3 participants