feat: update collaborate doc #2688
Conversation
WalkthroughThe documentation for the member management interface was updated in both English and Chinese. The revisions clarify permission levels, elaborate on the process of inviting members via a project link, specify invitation validity, and add notes about collaboration limits and future support for simultaneous editing. Visual and stylistic adjustments were also made. Changes
Poem
Note ⚡️ AI Code Reviews for VS Code, Cursor, WindsurfCodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback. 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 (
|
github-actions
bot
added
the
documentation
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (6)
docs/en/interface/sidebar.mdx (3)
44-45: Grammar and clarity: adjust possessive and pronouns for consistency.The sentence "After successfully adding them, you can still edit the member's permission levels or remove the member." uses singular possessive; consider pluralizing and streamlining pronouns. For example:
- After successfully adding them, you can still edit the member's permission levels or remove the member. + After successfully adding members, you can still edit their permission levels or remove them.
46-47: Consider using a callout for the editing limitation.This note about lack of simultaneous editing is important for users. Wrapping it in a callout will improve visibility:
- Please note that we currently do not support multiple users editing the same project simultaneously. We will support collaborative editing in future versions. + <Callout type="info"> + We currently do not support multiple users editing the same project simultaneously. Collaborative editing will be available in a future version. + </Callout>
48-49: Specify a callout type to emphasize the collaborator limit.To align with other callouts and highlight the 5-collaborator cap, consider adding a
typeattribute, e.g.:- <Callout>Each project can have a maximum of 5 collaborators</Callout> + <Callout type="warning">Each project can have a maximum of 5 collaborators</Callout>docs/zh/interface/sidebar.mdx (3)
44-45: 用词和一致性：优化权限描述和代词使用。“成功添加后，您仍然可以编辑成员的权限等级或移除该成员。” 建议简化代词并一致使用复数形式，例如：
- 成功添加后，您仍然可以编辑成员的权限等级或移除该成员。 + 成功添加后，您仍可编辑他们的权限等级或将其移除。
46-47: 考虑使用 Callout 提示框强调多用户编辑限制。这段关于暂不支持多人同时编辑的说明较为重要，可使用提示框提高可见性：
- 请注意，我们目前不支持多人同时编辑同一个项目。我们将在后续版本中支持多人协作编辑。 + <Callout type="info"> + 暂不支持多人同时编辑同一个项目，多人协作编辑功能将在后续版本上线。 + </Callout>
48-49: 统一示例中的 Callout 类型或样式。建议为 Callout 添加
type属性以与其他文档风格保持一致，例如：- <Callout>每个项目最多有 5 名协作者</Callout> + <Callout type="warning">每个项目最多有 5 名协作者</Callout>
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/en/interface/sidebar.mdx(1 hunks)docs/zh/interface/sidebar.mdx(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: e2e (22.x)
- GitHub Check: codecov
- GitHub Check: build (22.x, windows-latest)
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2688 +/- ##
==========================================
+ Coverage 79.47% 79.49% +0.02%
==========================================
Files 839 839
Lines 89263 89263
Branches 8775 8782 +7
==========================================
+ Hits 70938 70963 +25
+ Misses 18192 18167 -25
Partials 133 133
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Summary by CodeRabbit