Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update group config for Components category #155

Merged
merged 1 commit into from
Oct 15, 2024
Merged

Conversation

YumoImer
Copy link
Collaborator

@YumoImer YumoImer commented Oct 15, 2024

Summary by CodeRabbit

  • 新功能
    • 更新了组件的分类结构,提供了更清晰的文档组织。
  • 文档
    • 修改了多个组件的文档,以反映新的分组标题和顺序。
    • useXAgentuseXChat 组件的文档也进行了相应的更新。

@YumoImer YumoImer requested review from zombieJ and a team October 15, 2024 08:10
Copy link
Contributor

coderabbitai bot commented Oct 15, 2024

📝 Walkthrough

Walkthrough

此次更改主要涉及对themeConfig.ts文件的重大修改,特别是在导出的配置对象的typeOrder部分。多个与组件类型相关的现有键被删除并替换为新的键值。同时,多个组件文档文件的group字段也进行了更新,从简单字符串变为包含titleorder的结构化对象,以实现更好的分类和组织。

Changes

文件路径 更改摘要
.dumi/theme/themeConfig.ts 移除旧的typeOrder键(如GeneralLayout等),添加新键(如UIRuntime等)。更新中文键。
components/bubble/index.en-US.md 更新group字段为结构化对象,group: Data Display变更为group: { title: UI, order: 0 }
components/bubble/index.zh-CN.md 更新group字段为结构化对象,group: 数据展示变更为group: { title: 用户界面, order: 0 }
components/conversations/index.en-US.md 更新group字段为结构化对象,group: Data Display变更为group: { title: UI, order: 0 }
components/conversations/index.zh-CN.md 更新group字段为结构化对象,group: 数据展示变更为group: { title: 用户界面, order: 0 }
components/prompts/index.en-US.md 更新group字段为结构化对象,group: Data Display变更为group: { title: UI, order: 0 }
components/prompts/index.zh-CN.md 更新group字段为结构化对象,group: 数据展示变更为group: { title: 用户界面, order: 0 }
components/sender/index.en-US.md 更新group字段为结构化对象,group: Data Display变更为group: { title: UI, order: 0 }
components/sender/index.zh-CN.md 更新group字段为结构化对象,group: 数据展示变更为group: { title: 用户界面, order: 0 }
components/suggestion/index.en-US.md 更新group字段为结构化对象,group: Data Display变更为group: { title: UI, order: 0 }
components/suggestion/index.zh-CN.md 更新group字段为结构化对象,group: 数据展示变更为group: { title: 用户界面, order: 0 }
components/thought-chain/index.en-US.md 更新group字段为结构化对象,group: Data Display变更为group: { title: UI, order: 0 }
components/thought-chain/index.zh-CN.md 更新group字段为结构化对象,group: 数据展示变更为group: { title: 用户界面, order: 0 }
components/x-provider/index.en-US.md 更新group字段为结构化对象,group: Other变更为group: { title: Other, order: 3 }
components/x-provider/index.zh-CN.md 更新group字段为结构化对象,group: 其他变更为group: { title: 其他, order: 3 }
components/useXAgent/index.en-US.md 更新group字段为结构化对象,group: Runtime变更为group: { title: Runtime, order: 1 }
components/useXAgent/index.zh-CN.md 更新group字段为结构化对象,group: 运行时变更为group: { title: 运行时, order: 1 }
components/useXChat/index.en-US.md 更新group字段为结构化对象,group: Runtime变更为group: { title: Runtime, order: 1 }
components/useXChat/index.zh-CN.md 更新group字段为结构化对象,group: 运行时变更为group: { title: 运行时, order: 1 }

Poem

🐇 在兔子洞里欢跃跳,
主题更新真美妙。
新的分类如春花,
组件整齐排成行。
兔子舞动小脚丫,
一起庆祝这变化! 🌼


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between f436a50 and cef5076.

📒 Files selected for processing (21)
  • .dumi/theme/themeConfig.ts (1 hunks)
  • components/bubble/index.en-US.md (1 hunks)
  • components/bubble/index.zh-CN.md (1 hunks)
  • components/conversations/index.en-US.md (1 hunks)
  • components/conversations/index.zh-CN.md (1 hunks)
  • components/overview/index.en-US.md (1 hunks)
  • components/overview/index.zh-CN.md (1 hunks)
  • components/prompts/index.en-US.md (1 hunks)
  • components/prompts/index.zh-CN.md (1 hunks)
  • components/sender/index.en-US.md (1 hunks)
  • components/sender/index.zh-CN.md (1 hunks)
  • components/suggestion/index.en-US.md (1 hunks)
  • components/suggestion/index.zh-CN.md (1 hunks)
  • components/thought-chain/index.en-US.md (1 hunks)
  • components/thought-chain/index.zh-CN.md (1 hunks)
  • components/useXAgent/index.en-US.md (1 hunks)
  • components/useXAgent/index.zh-CN.md (1 hunks)
  • components/useXChat/index.en-US.md (1 hunks)
  • components/useXChat/index.zh-CN.md (1 hunks)
  • components/x-provider/index.en-US.md (1 hunks)
  • components/x-provider/index.zh-CN.md (1 hunks)

Note

🎁 Summarized by CodeRabbit Free

Your organization is on the Free plan. CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please upgrade your subscription to CodeRabbit Pro by visiting https://app.coderabbit.ai/login.

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

github-actions bot commented Oct 15, 2024

Preview is ready

Copy link

Deploying x with  Cloudflare Pages  Cloudflare Pages

Latest commit: cef5076
Status: ✅  Deploy successful!
Preview URL: https://b4ed6b4b.x-73x.pages.dev
Branch Preview URL: https://docs-group.x-73x.pages.dev

View logs

@YumoImer YumoImer enabled auto-merge (squash) October 15, 2024 08:11
Copy link
Contributor

@ONLY-yours ONLY-yours left a comment

Choose a reason for hiding this comment

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

+1

@YumoImer YumoImer merged commit a7adab9 into main Oct 15, 2024
9 checks passed
@YumoImer YumoImer deleted the docs/group branch October 15, 2024 08:13
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.

2 participants