Conversation
Add Beta notice to plugin documentation: - Update page titles to include (Beta) marker - Add warning callout about beta status and potential changes - Update navigation labels in vitepress config
There was a problem hiding this comment.
Pull request overview
This PR updates the documentation to clearly label the plugin system as Beta, setting expectations that the feature and its configuration may change over time.
Changes:
- Add “(Beta)” to the plugin documentation page titles (EN/ZH).
- Add warning callouts at the top of both plugin docs indicating Beta status and production-use caution.
- Update the VitePress sidebar labels to include “(Beta)” for the plugin entry (EN/ZH).
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/zh/customization/plugins.md | Adds Beta page title marker and a warning callout to communicate Beta status in Chinese docs. |
| docs/en/customization/plugins.md | Adds Beta page title marker and a warning callout to communicate Beta status in English docs. |
| docs/.vitepress/config.ts | Updates sidebar navigation labels to show plugin docs as “(Beta)” in both locales. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| # 插件 | ||
| # 插件 (Beta) | ||
|
|
||
| ::: warning Beta 功能 |
There was a problem hiding this comment.
The warning callout title doesn’t follow the docs style guide. For Chinese ::: warning blocks, the title should be 注意 (and put “Beta” wording in the content) per docs/AGENTS.md typography guidelines.
| ::: warning Beta 功能 | |
| ::: warning 注意 |
| # Plugins | ||
| # Plugins (Beta) | ||
|
|
||
| ::: warning Beta Feature |
There was a problem hiding this comment.
The ::: warning callout title should follow the docs style guide: English warnings typically use no title or a short generic title like Note (see docs/AGENTS.md). Consider changing the title from “Beta Feature” and keep the beta messaging in the block content.
| ::: warning Beta Feature | |
| ::: warning |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: b52fe69429
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| items: [ | ||
| { text: 'Model Context Protocol', link: '/en/customization/mcp' }, | ||
| { text: 'Plugins', link: '/en/customization/plugins' }, | ||
| { text: 'Plugins (Beta)', link: '/en/customization/plugins' }, |
There was a problem hiding this comment.
docs/AGENTS.md states "Do not change H1 titles or nav/sidebar labels," but this change renames the customization sidebar entry to Plugins (Beta) (and similarly in Chinese). That breaks the documented docs convention for stable navigation labels and can cause maintenance drift across mirrored locales; beta status should be conveyed in page content instead of the sidebar label.
Useful? React with 👍 / 👎.
| @@ -1,4 +1,8 @@ | |||
| # Plugins | |||
| # Plugins (Beta) | |||
There was a problem hiding this comment.
docs/AGENTS.md explicitly requires that H1 titles are not changed, but this commit rewrites the page heading from # Plugins to # Plugins (Beta). This violates the repository’s documentation contract and should be reverted, with beta messaging kept in a callout/body section instead.
Useful? React with 👍 / 👎.
| # 插件 | ||
| # 插件 (Beta) | ||
|
|
||
| ::: warning Beta 功能 |
There was a problem hiding this comment.
The Chinese docs style guide in docs/AGENTS.md requires warning callouts to use the category title 注意, with details moved into the body. Using ::: warning Beta 功能 breaks that documented convention and makes warning blocks inconsistent with the rest of the site.
Useful? React with 👍 / 👎.
![devin-ai-integration[bot]](https://avatars.githubusercontent.com/in/811515?s=60&v=4){kind=small}
| @@ -1,4 +1,8 @@ | |||
| # Plugins | |||
| # Plugins (Beta) | |||
There was a problem hiding this comment.
🔴 H1 title changed in English plugins page, violating docs/AGENTS.md rule
The rule at docs/AGENTS.md:38 states: "Do not change H1 titles or nav/sidebar labels." This PR changes the H1 from # Plugins to # Plugins (Beta). The "(Beta)" status information should be conveyed via the warning callout block (which is already added) rather than by modifying the H1 title.
| # Plugins (Beta) | |
| # Plugins |
Was this helpful? React with 👍 or 👎 to provide feedback.
| @@ -1,4 +1,8 @@ | |||
| # 插件 | |||
| # 插件 (Beta) | |||
There was a problem hiding this comment.
🔴 H1 title changed in Chinese plugins page, violating docs/AGENTS.md rule
The rule at docs/AGENTS.md:38 states: "Do not change H1 titles or nav/sidebar labels." This PR changes the H1 from # 插件 to # 插件 (Beta). The "(Beta)" status information should be conveyed via the warning callout block (which is already added) rather than by modifying the H1 title.
| # 插件 (Beta) | |
| # 插件 |
Was this helpful? React with 👍 or 👎 to provide feedback.
| items: [ | ||
| { text: 'Model Context Protocol', link: '/zh/customization/mcp' }, | ||
| { text: '插件', link: '/zh/customization/plugins' }, | ||
| { text: '插件 (Beta)', link: '/zh/customization/plugins' }, |
There was a problem hiding this comment.
🔴 Chinese sidebar label changed, violating docs/AGENTS.md rule
The rule at docs/AGENTS.md:38 states: "Do not change H1 titles or nav/sidebar labels." This PR changes the Chinese sidebar label from '插件' to '插件 (Beta)'. Sidebar labels should remain stable; the Beta status is already communicated by the warning callout on the page itself.
| { text: '插件 (Beta)', link: '/zh/customization/plugins' }, | |
| { text: '插件', link: '/zh/customization/plugins' }, |
Was this helpful? React with 👍 or 👎 to provide feedback.
| items: [ | ||
| { text: 'Model Context Protocol', link: '/en/customization/mcp' }, | ||
| { text: 'Plugins', link: '/en/customization/plugins' }, | ||
| { text: 'Plugins (Beta)', link: '/en/customization/plugins' }, |
There was a problem hiding this comment.
🔴 English sidebar label changed, violating docs/AGENTS.md rule
The rule at docs/AGENTS.md:38 states: "Do not change H1 titles or nav/sidebar labels." This PR changes the English sidebar label from 'Plugins' to 'Plugins (Beta)'. Sidebar labels should remain stable; the Beta status is already communicated by the warning callout on the page itself.
| { text: 'Plugins (Beta)', link: '/en/customization/plugins' }, | |
| { text: 'Plugins', link: '/en/customization/plugins' }, |
Was this helpful? React with 👍 or 👎 to provide feedback.
| # 插件 | ||
| # 插件 (Beta) | ||
|
|
||
| ::: warning Beta 功能 |
There was a problem hiding this comment.
🔴 Chinese warning callout uses wrong title "Beta 功能" instead of "注意"
The rule at docs/AGENTS.md:103-104 specifies: "Chinese: use 提示 for tip, 注意 for warning, 说明 for info, 警告 for danger." The callout ::: warning Beta 功能 should use ::: warning 注意 with "Beta 功能" content moved into the block body.
| ::: warning Beta 功能 | |
| ::: warning 注意 |
Was this helpful? React with 👍 or 👎 to provide feedback.
| # Plugins | ||
| # Plugins (Beta) | ||
|
|
||
| ::: warning Beta Feature |
There was a problem hiding this comment.
🔴 English warning callout uses descriptive title "Beta Feature" instead of short category word
The rule at docs/AGENTS.md:103-105 specifies: "Use short category titles for callout blocks... English: use no title or short words like Note for warning." The callout ::: warning Beta Feature should use ::: warning (no title) or ::: warning Note, with "Beta Feature" as part of the block content instead.
| ::: warning Beta Feature | |
| ::: warning Note |
Was this helpful? React with 👍 or 👎 to provide feedback.
This PR adds Beta notices to the plugin system documentation.
Changes
Purpose
Clearly communicate to users that the plugin system is a new feature that is still evolving, setting appropriate expectations about potential future changes.