chore: Update changelog and add TinyVue intelligent component access documentation #3498
Conversation
WalkthroughA new menu item for "智能化" (Intelligentization) has been added to the menu configuration. Two comprehensive documentation files—one in Chinese and one in English—have been introduced to guide users on integrating TinyVue's intelligent components. The changelog has been updated with a new entry detailing recent features, bug fixes, and contributor acknowledgments. Changes
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (7)
examples/sites/demos/pc/webdoc/mcp.md (5)
1-4: Add language switch link
Consider adding a link at the top to switch between Chinese and English versions (e.g.,[English](./mcp-en.md)) for better navigation.
5-11: Specify installation versions
You might include version constraints (e.g.,@opentiny/tiny-vue-mcp@^x.y.z) or mention--save/--save-devflags for clarity.
27-54: NextClient proxy example is clear
The Vue SFC snippet correctly sets upuseNextClient. Consider adding a brief note about the SSE proxy server requirements here if not covered elsewhere.
84-89: List formatting is fine
The 注意事项 list is concise. Optionally, unify punctuation (e.g., remove trailing periods).
90-102: FAQ section structured well
Nested lists are indented correctly. You may want to hyperlink common error codes or logs in a future iteration.examples/sites/demos/pc/webdoc/mcp-en.md (1)
1-4: Add link to Chinese version
Include a link to the Chinese guide (e.g.,[中文版](./mcp.md)) at the top of the document for bilingual navigation.examples/sites/demos/pc/webdoc/changelog.md (1)
23-23: Consistent acronym casing
Change “mcp” to uppercase “MCP” for consistency with other entries:- - feat(grid): optimize mcp configuration usage and sample code by @zzcr ... + - feat(grid): optimize MCP configuration usage and sample code by @zzcr ...
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
examples/sites/demos/pc/menus.js(1 hunks)examples/sites/demos/pc/webdoc/changelog.md(1 hunks)examples/sites/demos/pc/webdoc/mcp-en.md(1 hunks)examples/sites/demos/pc/webdoc/mcp.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
examples/sites/demos/pc/webdoc/changelog.md
[style] ~30-~30: Unless you want to emphasize “not”, use “cannot” which is more common.
Context: .../tiny-vue/pull/3445> - fix(select): fix can not set grid rowId in select by @gimmyhehe ...
(CAN_NOT_PREMIUM)
🔇 Additional comments (4)
examples/sites/demos/pc/menus.js (1)
45-49: Verify MCP menu entry configuration
The new “智能化”/“mcp” item is correctly inserted between theme-dark and formValid. Ensure that corresponding docs files (mcp.mdandmcp-en.md) exist atexamples/sites/demos/pc/webdoc/and that your routing logic handles thekey: 'mcp'.examples/sites/demos/pc/webdoc/mcp.md (2)
13-25: Initialization snippet looks correct
The JS code block properly demonstratesregisterMcpConfig. Confirm that this matches the actual path of your entry file (main.js/main.ts).
56-82: MCP component configuration is accurate
Thetiny-gridexample anduseNextServercall align with the integration guide. No issues found.examples/sites/demos/pc/webdoc/changelog.md (1)
7-24: Changelog entry for v3.24.0/v2.24.0 looks good
Version header, date, and feature list align with existing format. The new features (including MCP support) are properly documented.
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
examples/sites/demos/pc/menus.js(1 hunks)examples/sites/demos/pc/webdoc/changelog.md(1 hunks)examples/sites/demos/pc/webdoc/mcp-en.md(1 hunks)examples/sites/demos/pc/webdoc/mcp.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
examples/sites/demos/pc/webdoc/changelog.md
[style] ~30-~30: Unless you want to emphasize “not”, use “cannot” which is more common.
Context: .../tiny-vue/pull/3445> - fix(select): fix can not set grid rowId in select by @gimmyhehe ...
(CAN_NOT_PREMIUM)
🔇 Additional comments (3)
examples/sites/demos/pc/menus.js (1)
45-49: New MCP menu item integration is correct.The insertion of the "智能化" / "mcp" entry aligns with the new documentation and follows the existing menu structure without disrupting order or filtering logic.
examples/sites/demos/pc/webdoc/mcp.md (1)
1-102: Chinese MCP integration guide documentation looks comprehensive.The Markdown layout, localized headings, and code examples are clear and correctly formatted. No issues detected.
examples/sites/demos/pc/webdoc/changelog.md (1)
7-54: Changelog entry for v3.24.0/v2.24.0 is accurate and well-structured.The new version header, feature list, bug fixes, and contributor acknowledgments are clearly documented and formatted.
🧰 Tools
🪛 LanguageTool
[style] ~30-~30: Unless you want to emphasize “not”, use “cannot” which is more common.
Context: .../tiny-vue/pull/3445> - fix(select): fix can not set grid rowId in select by @gimmyhehe ...(CAN_NOT_PREMIUM)
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (3)
examples/sites/demos/pc/webdoc/mcp-en.md (2)
1-3: Refine the document title for clarity.Consider changing to "TinyVue Intelligent Components Integration Guide" to more precisely reflect the integration focus.
56-58: Complete the introductory sentence under MCP Component Configuration.The fragment "When using" is incomplete. For example:
"When using MCP-enabled components such astiny-grid, configure them as follows:"examples/sites/demos/pc/webdoc/changelog.md (1)
29-30: Use "cannot" instead of "can not" for consistency.Change:
- fix(select): fix can not set grid rowId in select by @gimmyhehe + fix(select): fix cannot set grid rowId in select by @gimmyhehe🧰 Tools
🪛 LanguageTool
[style] ~30-~30: Unless you want to emphasize “not”, use “cannot” which is more common.
Context: .../tiny-vue/pull/3445> - fix(select): fix can not set grid rowId in select by @gimmyhehe ...(CAN_NOT_PREMIUM)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
examples/sites/demos/pc/menus.js(1 hunks)examples/sites/demos/pc/webdoc/changelog.md(1 hunks)examples/sites/demos/pc/webdoc/mcp-en.md(1 hunks)examples/sites/demos/pc/webdoc/mcp.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
examples/sites/demos/pc/webdoc/changelog.md
[style] ~30-~30: Unless you want to emphasize “not”, use “cannot” which is more common.
Context: .../tiny-vue/pull/3445> - fix(select): fix can not set grid rowId in select by @gimmyhehe ...
(CAN_NOT_PREMIUM)
🔇 Additional comments (3)
examples/sites/demos/pc/menus.js (1)
45-49: Add new '智能化' ('mcp') menu item for documentation navigation.Placement and keys align with the new MCP integration guides and match the filenames (
mcp.md/mcp-en.md).examples/sites/demos/pc/webdoc/mcp-en.md (1)
9-11: Verify code examples for accuracy.All installation and setup snippets appear correct and self-contained.
Also applies to: 19-25, 32-46, 61-82
examples/sites/demos/pc/webdoc/mcp.md (1)
1-102: Chinese MCP integration guide is well-structured.The documentation is clear, with accurate code examples and appropriate sectioning.
|
|
||
| TinyVue's intelligent components provide a complete intelligent solution, allowing your application to have AI conversation, voice interaction, and other capabilities. This guide will walk you through how to integrate TinyVue's intelligent components into your project. | ||
|
|
||
| ## 安装依赖 |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Translate Chinese headings to English.
The English version mixes Chinese section titles ("安装依赖", "接入步骤", "常见问题"). Please update to "## Install Dependencies", "## Integration Steps", and "## Frequently Asked Questions".
Also applies to: 13-13, 90-90
🤖 Prompt for AI Agents
In examples/sites/demos/pc/webdoc/mcp-en.md at lines 5, 13, and 90, the section
headings are still in Chinese ("安装依赖", "接入步骤", "常见问题"). Replace these Chinese
headings with their English equivalents: "## Install Dependencies" at line 5,
"## Integration Steps" at line 13, and "## Frequently Asked Questions" at line
90 to maintain consistency in the English document.
* feat: New MCP comprehensive example added to the official website (#3497) * feat: 官网新增mcp综合示例 * fix: 修复 tiny-robot-chat 组件中的提示项和建议项的传递逻辑，优化 Demo 组件的 QR 码展示样式 * fix: 修复引入路径问题 * chore: Update changelog and add TinyVue intelligent component access documentation (#3498) * chore: 更新changelog，并添加TinyVue智能化组件接入文档 * chore: 添加菜单优化文档 * chore: 更新mcp.md文档中的sessionId说明，简化调试提示 * chore: 更新mcp-en.md文档中的标题和内容，统一语言为英文 * feat: add remote control page, update next dependency (#3501) * feat: 添加遥控器页面，更新next依赖 * chore: 修改代理为https url * feat: 更新会话ID的处理逻辑 * fix: 更新依赖版本约束以支持更高版本 * fix: 更新版本号至3.24.4
chore: 更新changelog，并添加TinyVue智能化组件接入文档
PR
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
What is the current behavior?
Issue Number: N/A
What is the new behavior?
Does this PR introduce a breaking change?
Other information
Summary by CodeRabbit
New Features
Documentation