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: sync antd .dumi to x #139

Merged
merged 18 commits into from
Oct 9, 2024
Merged

docs: sync antd .dumi to x #139

merged 18 commits into from
Oct 9, 2024

Conversation

afc163
Copy link
Member

@afc163 afc163 commented Oct 9, 2024

  • 从 antd 主仓库同步 .dumi 文档的一些改动。
  • 更新中英文 slogan。close 简化中英文 slogan #135
  • 更新依赖版本和 snapshot:snapshot 的变化主要是 antd 升级带来的变动,符合预期。

Summary by CodeRabbit

  • 新特性
    • 更新了应用中的多个组件和文档,增强了用户界面的可用性和一致性。
    • 新增了 Audio 组件,支持音频播放功能。
    • ComponentMeta 组件中添加了变更日志链接,提升了用户对组件更新的可见性。
  • Bug 修复
    • 修复了 ResourceArticles 组件在处理无文章时的错误。
  • 文档
    • 更新了 README.mdREADME-zh_CN.md 文件中的项目描述,以更好地反映产品的定位。
  • 样式
    • 改进了多个组件的样式,确保更一致的视觉效果。

Copy link

github-actions bot commented Oct 9, 2024

Preview is ready

Copy link

cloudflare-workers-and-pages bot commented Oct 9, 2024

Deploying x with  Cloudflare Pages  Cloudflare Pages

Latest commit: aedfd23
Status: ✅  Deploy successful!
Preview URL: https://f7a485f7.x-73x.pages.dev
Branch Preview URL: https://docs-sync-dumi.x-73x.pages.dev

View logs

Copy link

socket-security bot commented Oct 9, 2024

New and removed dependencies detected. Learn more about Socket for GitHub ↗︎

Package New capabilities Transitives Size Publisher
npm/@emotion/[email protected] environment 0 48.7 kB emotion-release-bot

View full report↗︎

@afc163 afc163 changed the title [WIP] docs: sync antd .dumi to x docs: sync antd .dumi to x Oct 9, 2024
@afc163 afc163 marked this pull request as ready for review October 9, 2024 08:05
Copy link
Contributor

coderabbitai bot commented Oct 9, 2024

📝 Walkthrough

Walkthrough

此次更改涉及多个文件的修改,主要集中在组件的导出、样式、国际化文本和功能逻辑的调整。关键变更包括在 .dumi/loading.js 中添加默认导出,在 BannerRecommends.tsxIconSearch/index.tsx 中更新数组实例化方式,更新 PreviewBannerDocLayout 组件的国际化文本,以及对多个组件的样式和结构进行优化。此外,新增了 Audio 组件,并对多个文件中的 GitHub 链接进行了更新。

Changes

文件路径 变更摘要
.dumi/loading.js 删除 ESLint 注释,添加默认导出 export { default } from './theme/common/Loading';
.dumi/pages/index/components/BannerRecommends.tsx Array(3).fill(1) 替换为 new Array(3).fill(1)
.dumi/pages/index/components/PreviewBanner/index.tsx 更新中英文的 slogan 文本
.dumi/rehypeAntd.ts 更新节点转换逻辑,处理 TableLinkvideo 标签,改进 SourceCode 处理
.dumi/theme/SiteThemeProvider.tsx 修改导入顺序,扩展 CustomToken 接口
.dumi/theme/builtins/Audio/index.tsx 新增 Audio 组件,接受 domId 属性并触发音频播放
.dumi/theme/builtins/ComponentMeta/index.tsx 添加 HistoryOutlined 图标,新增 changelog 本地化文本,更新渲染逻辑
.dumi/theme/builtins/ComponentTokenTable/index.tsx 添加 TokenData 类型导入,更新 map 函数类型
.dumi/theme/builtins/DemoWrapper/index.tsx 修改 demos 变量构建逻辑,更新样式类名
.dumi/theme/builtins/IconSearch/IconSearch.tsx 更新 searchKey 处理逻辑
.dumi/theme/builtins/IconSearch/index.tsx Array(24).fill(1) 替换为 new Array(24).fill(1)
.dumi/theme/builtins/Previewer/index.tsx Previewer 的懒加载改为直接导入
.dumi/theme/builtins/ResourceArticles/index.tsx 更新 ArticleList 组件以处理空数据的情况,优化文章展示逻辑
.dumi/theme/builtins/ResourceCards/index.tsx 修改 CSS 选择器以改变样式应用方式
.dumi/theme/builtins/TokenTable/index.tsx TokenData 类型的可见性从私有更改为公共
.dumi/theme/common/BehaviorMap/BehaviorMap.tsx 将 G6 节点注册改为异步导入
.dumi/theme/common/ComponentChangelog/ComponentChangelog.tsx 简化组件结构,新增 ChangelogInfo 接口
.dumi/theme/common/EditButton.tsx 更新 branchUrl 常量,指向新的 GitHub 地址
.dumi/theme/common/ThemeSwitch/ThemeIcon.tsx 提取 SVGIcon 组件为独立功能组件
.dumi/theme/common/ThemeSwitch/index.tsx 移除对 useTheme 的依赖,简化样式处理
.dumi/theme/common/styles/Demo.tsx 新增 .code-box-debug 样式规则
.dumi/theme/common/styles/Markdown.tsx 扩展图像选择器以包含列表项中的图像
.dumi/theme/layouts/DocLayout/index.tsx 更新中英文的 titledescription 属性
.dumi/theme/layouts/GlobalLayout.tsx 精简 useServerInsertedHTML 的注释,优化样式提取逻辑
.dumi/theme/plugin.ts 更新 AntdReactTechStack 类和 RoutesPlugin 函数以增强样式提取和路由管理功能
.dumi/theme/slots/Content/ColumnCard.tsx 更新 <img> 元素的 alt 属性
.dumi/theme/slots/Content/index.tsx 移除对 ComponentChangelog 的导入和使用
.dumi/theme/slots/Footer/index.tsx 更新 GitHub 链接到新的地址
.dumi/theme/slots/Header/Navigation.tsx 更新 GitHub 链接,移除资源菜单项
.dumi/theme/slots/Header/index.tsx 更新 GitHub 链接,修改版本处理和语言切换逻辑
.dumi/theme/themeConfig.ts 更新 typeOrder 对象中的条目顺序
README-zh_CN.md 更新介绍文本
README.md 更新项目描述
package.json 添加新依赖 @emotion/server

Poem

在代码的草地上,兔子欢快跳,
新功能如花开,绽放美妙。
链接更新,样式新,
组件齐心协力,共筑梦想城。
让我们一起欢庆这变化,
兔子在旁,欢声笑语不绝。 🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between e3fb9af and 08db937.

⛔ Files ignored due to path filters (1)
  • bun.lockb is excluded by !**/bun.lockb
📒 Files selected for processing (34)
  • .dumi/loading.js (1 hunks)
  • .dumi/pages/index/components/BannerRecommends.tsx (2 hunks)
  • .dumi/pages/index/components/PreviewBanner/index.tsx (1 hunks)
  • .dumi/rehypeAntd.ts (1 hunks)
  • .dumi/theme/SiteThemeProvider.tsx (1 hunks)
  • .dumi/theme/builtins/Audio/index.tsx (1 hunks)
  • .dumi/theme/builtins/ComponentMeta/index.tsx (4 hunks)
  • .dumi/theme/builtins/ComponentTokenTable/index.tsx (3 hunks)
  • .dumi/theme/builtins/DemoWrapper/index.tsx (2 hunks)
  • .dumi/theme/builtins/IconSearch/IconSearch.tsx (1 hunks)
  • .dumi/theme/builtins/IconSearch/index.tsx (2 hunks)
  • .dumi/theme/builtins/Previewer/index.tsx (1 hunks)
  • .dumi/theme/builtins/ResourceArticles/index.tsx (0 hunks)
  • .dumi/theme/builtins/ResourceCards/index.tsx (1 hunks)
  • .dumi/theme/builtins/TokenTable/index.tsx (2 hunks)
  • .dumi/theme/common/BehaviorMap/BehaviorMap.tsx (1 hunks)
  • .dumi/theme/common/ComponentChangelog/ComponentChangelog.tsx (7 hunks)
  • .dumi/theme/common/EditButton.tsx (1 hunks)
  • .dumi/theme/common/ThemeSwitch/ThemeIcon.tsx (1 hunks)
  • .dumi/theme/common/ThemeSwitch/index.tsx (3 hunks)
  • .dumi/theme/common/styles/Demo.tsx (2 hunks)
  • .dumi/theme/common/styles/Markdown.tsx (1 hunks)
  • .dumi/theme/layouts/DocLayout/index.tsx (1 hunks)
  • .dumi/theme/layouts/GlobalLayout.tsx (3 hunks)
  • .dumi/theme/plugin.ts (0 hunks)
  • .dumi/theme/slots/Content/ColumnCard.tsx (3 hunks)
  • .dumi/theme/slots/Content/index.tsx (0 hunks)
  • .dumi/theme/slots/Footer/index.tsx (2 hunks)
  • .dumi/theme/slots/Header/Navigation.tsx (1 hunks)
  • .dumi/theme/slots/Header/index.tsx (1 hunks)
  • .dumi/theme/themeConfig.ts (1 hunks)
  • README-zh_CN.md (1 hunks)
  • README.md (1 hunks)
  • package.json (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.

description:
'An enterprise-class UI design language and React UI library with a set of high-quality React components, one of best React UI library for enterprises',
title: 'Ant Design X',
description: 'The ready-made partner for building Copilot applications.',
Copy link
Member Author

Choose a reason for hiding this comment

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

close #135

@afc163 afc163 enabled auto-merge (squash) October 9, 2024 08:32
@afc163 afc163 merged commit e6e7561 into main Oct 9, 2024
10 checks passed
@afc163 afc163 deleted the docs/sync-dumi branch October 9, 2024 08:46
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

@afc163 afc163 restored the docs/sync-dumi branch October 10, 2024 01:43
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.

4 participants