Skip to content

Conversation

@gimmyhehe
Copy link
Member

@gimmyhehe gimmyhehe commented Jan 28, 2026

更新genui-sdk的开发文档

Summary by CodeRabbit

  • New Features

    • Added tabbed content support to documentation for improved readability.
    • Enhanced navigation with deeper outline structure for better discoverability.
    • Reorganized documentation with new sections for Genui SDK components, server documentation, and Angular documentation.
  • Chores

    • Updated Genui SDK dependency version.

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai
Copy link

coderabbitai bot commented Jan 28, 2026

Walkthrough

VitePress configuration integrates a tabs plugin for enhanced documentation navigation, reorganizes sidebar/navigation entries, and enables deep outline navigation. Related theme and dependency files are updated accordingly, along with SDK version bumps for the genui project.

Changes

Cohort / File(s) Summary
VitePress Tabs Plugin Integration
package.json, .vitepress/config.mts, .vitepress/theme/index.ts
Added vitepress-plugin-tabs ^0.7.3 as devDependency; integrated tabsMarkdownPlugin into markdown config with md.use(); enhanced theme with enhanceAppWithTabs(app) client-side initialization
Documentation Navigation & Configuration
.vitepress/config.mts
Enabled deep outline navigation (outline: 'deep'); reorganized sidebar and navigation entries including new Genui SDK components sections, server/Angular docs subsections, and example groups; renamed several entries for consistency (e.g., "搭配 Tiny Robot 使用" → "搭配 TinyRobot 使用")
Theme Updates
.vitepress/theme/Layout.vue
Removed dynamic title update call for genui-sdk navigation (updateMultipleDocTitle('genui-sdk', cfg.genuiNav)) from route watcher
SDK Dependencies
genui/package.json, genui/genui-sdk
Updated @opentiny/genui-sdk-vue from 0.0.1-alpha.8 to 1.0.0-beta.1; advanced genui-sdk submodule pointer to commit f7c77211c63af52e6e086cc4c708f56161614fbe

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Poem

🐰 Tabs and navigation bright,
Configuration set just right,
Plugins dance through config's stage,
SDK steps to the next page,
Documentation now more light! ✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'fix(genui): update genui docs' accurately reflects the primary changes in the changeset, which include VitePress configuration updates, theme modifications, tabs plugin integration, and genui-sdk documentation-related updates.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch deploy/update-genui-docs

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
.vitepress/config.mts (1)

124-312: Critical issue: Sidebar configuration references hundreds of non-existent documentation files.

The entire documentation structure is missing from the repository. Only 3 markdown files exist (README.md, downloads/extension.md, index.md), but the sidebar config in lines 124-312 references files across three major doc sections that don't exist:

  • /tiny-robot/guide/ (quick-start, theme-config, update-log, container, bubble, etc.)
  • /next-sdk/guide/ (mcp-host, electron, uni-app, api-client, etc.)
  • /genui-sdk/guide/ and /genui-sdk/components/ and /genui-sdk/examples/ (quick-start, renderer, custom-actions, etc.)

With ignoreDeadLinks: true enabled, the build won't detect these broken links. Create the actual markdown files for all referenced pages before deploying this configuration, or disable the dead link ignoring to expose the issue during build.

rhlin
rhlin previously approved these changes Jan 28, 2026
@rhlin rhlin merged commit 8633bcb into dev Jan 28, 2026
2 of 3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants