8000 docs: modification tips by kimteayon · Pull Request #844 · ant-design/x · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

docs: modification tips #844

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

Merged
merged 2 commits into from
May 21, 2025
Merged

docs: modification tips #844

merged 2 commits into from
May 21, 2025

Conversation

kimteayon
Copy link
Collaborator
@kimteayon kimteayon commented May 21, 2025

🤔 This is a ...

  • 🆕 New feature
  • 🐞 Bug fix
  • 📝 Site / documentation improvement
  • 📽️ Demo improvement
  • 💄 Component style improvement
  • 🤖 TypeScript definition improvement
  • 📦 Bundle size optimization
  • ⚡️ Performance optimization
  • ⭐️ Feature enhancement
  • 🌐 Internationalization
  • 🛠 Refactoring
  • 🎨 Code style optimization
  • ✅ Test Case
  • 🔀 Branch merge
  • ⏩ Workflow
  • ⌨️ Accessibility improvement
  • ❓ Other (about what?)

修复一些文档格式

Summary by CodeRabbit

  • Bug Fixes

    • 复制文本时的用户提示信息由中文改为英文。
  • Documentation

    • 修正了 Bubble 组件英文文档 API 表格的排版和属性说明,使其更清晰易读。

Copy link
Contributor
coderabbitai bot commented May 21, 2025
📝 Walkthrough

Walkthrough

本次更改包括两个方面:一是将 Bubble 组件演示文件中的复制提示信息由中文改为英文;二是修正了 Bubble 组件英文文档中 API 表格的格式,将合并的行拆分为两个独立的行,提升了表格的清晰度和准确性。

Changes

文件/路径 变更摘要
components/bubble/demo/header-and-footer.tsx 将复制相关的用户提示信息从中文更改为英文,未更改逻辑和控制流。
components/bubble/index.en-US.md 修正 API 表格格式,将 shapestyles 属性分为独立的行。

Suggested labels

documentation, lgtm

Suggested reviewers

  • hylin

Poem

🐰
代码如泡泡,轻盈又透明,
英文提示闪亮,文档更分明。
表格行分开,信息不再乱,
小兔挥挥手,细节皆完善!

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit 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.
Learn more here.


Note

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 30th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.
Enjoy the performance boost—your workflow just got faster.

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate Unit Tests
  • Create PR with Unit Tests
  • Commit Unit Tests in branch docfeature
  • Post Copyable Unit Tests in Comment

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.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need 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)

  • @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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai auto-generate unit tests to generate unit tests for this 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
Contributor
github-actions bot commented May 21, 2025

Preview is ready

Copy link

Walkthrough: This pull request focuses on improving the documentation by fixing formatting issues and updating text content for clarity. The changes include modifications to the text in a TypeScript file and adjustments in a markdown documentation file.

Changes:

Files Summary
components/bubble/demo/header-and-footer.tsx Updated text content for message success notifications from Chinese to English.
components/bubble/index.en-US.md Fixed formatting issues in the documentation table, ensuring proper alignment and clarity.

Copy link
codecov bot commented May 21, 2025

Bundle Report

Changes will increase total bundle size by 28 bytes (0.02%) ⬆️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
antdx-array-push 136.17kB 28 bytes (0.02%) ⬆️

Affected Assets, Files, and Routes:

view changes for bundle: antdx-array-push

Assets Changed:

Asset Name Size Change Total Size Change (%)
antdx.min.js 28 bytes 136.17kB 0.02%

@dosubot dosubot bot added the documentation Improvements or additions to documentation label May 21, 2025
Copy link
Contributor
@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (2)
components/bubble/demo/header-and-footer.tsx (1)

10-10: 统一冒号样式
当前模板字符串使用了中文全角冒号 “:”,建议替换为英文半角冒号 “:”,以保持英文提示的一致性:

- message.success(`Text copied successfully:${textToCopy}`);
+ message.success(`Text copied successfully: ${textToCopy}`);
components/bubble/index.en-US.md (1)

53-54: 修正 shape 行的 Version 列
shapestyles 已正确拆分,提升了表格可读性。建议将 shape 行的 Version 列保持为空(与 placement 一致),而非使用 -,以统一表格风格:

- | shape | Shape of bubble | `round` \| `corner` | - | - |  
+ | shape | Shape of bubble | `round` \| `corner` | - |  |
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between aa2d426 and e5b38b8.

📒 Files selected for processing (2)
  • components/bubble/demo/header-and-footer.tsx (1 hunks)
  • components/bubble/index.en-US.md (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: test / react component workflow
  • GitHub Check: build preview
  • GitHub Check: size
🔇 Additional comments (1)
components/bubble/demo/header-and-footer.tsx (1)

9-9: 翻译正确,无逻辑变更
已将空内容提示从“文本为空”改为“Text is empty”,翻译贴切且保留了原有控制流。

Copy link
codecov bot commented May 21, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.34%. Comparing base (340dfee) to head (87b2b4c).
Report is 7 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #844      +/-   ##
==========================================
- Coverage   92.35%   92.34%   -0.02%     
==========================================
  Files          66       66              
  Lines        1492     1490       -2     
  Branches      405      401       -4     
==========================================
- Hits         1378     1376       -2     
  Misses        114      114              

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
@Chuck-Ray Chuck-Ray left a comment

Choose a reason for hiding this comment

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

很棒,没有问题

@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label May 21, 2025
Copy link
Contributor
@pokerface9830 pokerface9830 left a comment

Choose a reason for hiding this comment

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

accept

@kimteayon kimteayon merged commit 94fe84b into ant-design:main May 21, 2025
9 checks passed
kimteayon added a commit that referenced this pull request May 21, 2025
* chore: sync main to feature branch  (#810)

* fix(attachment): fix image display style (#751)

* chore: update CodePreviewer to support React 19 (#758)

* docs: update a new contributions charts (#761)

* fix: fix some potential issue (#773)

* refactor: using setState function (#774)

Co-authored-by: vanndxh <wangyuezhou.wyz@digital-engine.com>

* type: fix some potential issue (#775)

* fix: watch config three sub-items  (#777)

* feat: function setState

* fix: watch config

---------

Co-authored-by: vanndxh <wangyuezhou.wyz@digital-engine.com>

* fix: fix Conversations ellipsis tooltip issues by removing it (#776)

* fix: fix Conversations ellipsis tooltip issues by removing it

* test: update snapshot

* style: use native text overflow style

* docs: changelog of 1.2.0 (#778)

* fix: fix some potential issue

* fix: fix some potential issue

* fix: fix some potential issue

* docs: changelog of 1.2.0

* docs: changelog of 1.2.0

* docs: changelog of 1.2.0

* docs: changelog of 1.2.0

* docs: changelog of 1.2.0

* docs: changelog of 1.2.0

* docs: changelog of 1.2.0

* 🏷️ type: add Conversation type export (#258)

Co-authored-by: afc163 <afc163@gmail.com>

* docs: fix the wrong docs of ThoughtChain (#781)

* fix: fix some potential issue

* fix: fix some potential issue

* fix: fix some potential issue

* docs: changelog of 1.2.0

* docs: changelog of 1.2.0

* docs: changelog of 1.2.0

* docs: changelog of
A953
 1.2.0

* docs: changelog of 1.2.0

* docs: changelog of 1.2.0

* docs: changelog of 1.2.0

* docs: fix the wrong docs of ThoughtChain

* docs: optimize Bubble.List scoll position

* docs: fix thought-chain and changelog

* fix: Prompts scroll styles (#785)

* fix: Prompts srollX

* fix: Prompts srollX

* docs: optimize Bubble.List scroll bar position (#783)

* docs: optimize Bubble.List scoll position

* docs: optimize Bubble.List scoll position

* test: demo snap

* fix: Prompts srollX

* chore: sync main to feature branch

---------

Co-authored-by: wzc520pyfm <1528857653@qq.com>
Co-authored-by: ice <49827327+coding-ice@users.noreply.github.com>
Co-authored-by: Shinji-Li <1349021570@qq.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Vanndxh <77873426+vanndxh@users.noreply.github.com>
Co-authored-by: vanndxh <wangyuezhou.wyz@digital-engine.com>
Co-authored-by: afc163 <afc163@gmail.com>

* chore: fix  warning of deprecated API (#827)

* chore: fix  warning of deprecated API

* chore: fix ts

* chore: fix logic

* test: ignore legacy

* chore: delete webpack.config.js (#229)

* docs(bubble): update content and messageRender type (#814)

* docs: sender supplement documents to address user inquiries (#835)

* docs: supplement documents to address user inquiries

* docs: sender

* chore: sync main to feature branch

* feat:  make the Bubble foot and header to get from context  & Bubble can get key (#683)

* feat:  调整Bubble foot,header参数,支持头部获取上下文

* fix: # 支持useXAgent通过deps 获取最新状态

* fix: 剔多余提交

* fix: 英文文档格式修复

* fix  简化参数

* Update header-and-footer.tsx

fix: 调整用例

* feat: bubble's footer and header

* feat: bubble's footer and header

* test: bubble's footer and header

* fix: ts of key

* fix: ts of key

---------

Co-authored-by: Mickey <951203214@qq.com>

* fix: resolve the security issues of apikey (#840)

* fix: Resolve the security issues of apikey

* fix: Resolve the security issues of apikey

* test: update snap

* fix:api key and stream

* fix:api key and stream

* docs: modification tips (#844)

* docs: changelog of 1.3.0 (#845)

* test: sender

* test: delete

* docs: changelog of 1.3.0

* docs: changelog of 1.3.0

* docs: changelog of 1.3.0

---------

Co-authored-by: wzc520pyfm <1528857653@qq.com>
Co-authored-by: ice <49827327+coding-ice@users.noreply.github.com>
Co-authored-by: Shinji-Li <1349021570@qq.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Vanndxh <77873426+vanndxh@users.noreply.github.com>
Co-authored-by: vanndxh <wangyuezhou.wyz@digital-engine.com>
Co-authored-by: afc163 <afc163@gmail.com>
Co-authored-by: 二货爱吃白萝卜 <smith3816@gmail.com>
Co-authored-by: Lawliet <37376096+L-Hknu@users.noreply.github.com>
coding-ice pushed a commit to coding-ice/x that referenced this pull request Jun 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation lgtm This PR has been approved by a maintainer
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants
0