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: Improve document syntax #331

Merged
merged 1 commit into from
Dec 9, 2024

Conversation

Wxh16144
Copy link
Member

@Wxh16144 Wxh16144 commented Dec 9, 2024

使用 [```diff`] 改进文档语法~

before

image

after

image

Summary by CodeRabbit

  • 新功能
    • 更新了 XProvider 组件的文档,替换了 antdConfigProvider,并提供了新的使用示例。
    • 文档中增加了如何使用 XProvider 组件的代码片段,展示了其在应用中的包装方式。

Copy link
Contributor

coderabbitai bot commented Dec 9, 2024

📝 Walkthrough

Walkthrough

此次更改主要集中在XProvider组件的文档更新上,涉及两个文件:components/x-provider/index.en-US.mdcomponents/x-provider/index.zh-CN.md。文档中将antdConfigProvider替换为@ant-design/xXProvider,并相应更新了导入语句和使用示例。示例代码展示了如何使用XProvider包装应用组件,API部分保持不变,继续提供对各组件全局配置的支持。

Changes

文件路径 更改摘要
components/x-provider/index.en-US.md 更新文档,将ConfigProvider替换为XProvider,并修改使用示例以展示新的组件结构。
components/x-provider/index.zh-CN.md 更新文档,将ConfigProvider替换为XProvider,并调整使用示例以反映新的组件导入和使用方式。

Possibly related PRs

Suggested reviewers

  • afc163
  • YumoImer

🐰 在文档中跳跃,更新真精彩,
XProvider新姿态,功能更强大!
组件包裹应用,配置无忧愁,
让我们一起欢呼,代码更美好! 🎉


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 32ddbe7 and 1873c8f.

📒 Files selected for processing (2)
  • components/x-provider/index.en-US.md (1 hunks)
  • components/x-provider/index.zh-CN.md (1 hunks)
🔇 Additional comments (2)
components/x-provider/index.zh-CN.md (1)

22-32: 代码示例清晰明了!

代码块使用了正确的 diff 语法标记,清晰地展示了从 ConfigProvider 迁移到 XProvider 的具体步骤。示例简洁且符合最佳实践。

components/x-provider/index.en-US.md (1)

21-31: 中英文文档保持一致性!

英文文档中的代码示例与中文文档完全一致,保持了良好的文档同步性。diff 语法的使用也同样规范清晰。


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 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 Dec 9, 2024

Preview is ready

Copy link

codecov bot commented Dec 9, 2024

Bundle Report

Bundle size has no change ✅

Copy link

codecov bot commented Dec 9, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.36%. Comparing base (32ddbe7) to head (1873c8f).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #331   +/-   ##
=======================================
  Coverage   91.36%   91.36%           
=======================================
  Files          66       66           
  Lines        1447     1447           
  Branches      368      368           
=======================================
  Hits         1322     1322           
  Misses        125      125           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Collaborator

@YumoImer YumoImer left a comment

Choose a reason for hiding this comment

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

感谢贡献!

@YumoImer YumoImer merged commit 4dfe300 into ant-design:main Dec 9, 2024
11 checks passed
@coderabbitai coderabbitai bot mentioned this pull request Dec 10, 2024
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