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: replace introduce img url #377

Merged
merged 4 commits into from
Dec 20, 2024
Merged

docs: replace introduce img url #377

merged 4 commits into from
Dec 20, 2024

Conversation

YumoImer
Copy link
Collaborator

@YumoImer YumoImer commented Dec 20, 2024

Summary by CodeRabbit

  • 文档更新
    • 更新了英文和中文文档中的图片链接。
    • 加强了关于RICH设计范式的内容,介绍了其四个关键元素:意图、角色、对话和混合用户界面。

Copy link
Contributor

coderabbitai bot commented Dec 20, 2024

Important

Review skipped

Review was skipped due to path filters

⛔ Files ignored due to path filters (1)
  • bun.lockb is excluded by !**/bun.lockb

CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including **/dist/** will override the default block on the dist directory, by removing the pattern from both the lists.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

📝 Walkthrough
📝 Walkthrough
📝 Walkthrough
📝 Walkthrough

概述

演练

本次更改主要涉及文档 docs/spec/introduce.en-US.mddocs/spec/introduce.zh-CN.md 的更新。两个文档都进行了图像链接的替换,并对 RICH 设计范式的内容进行了细微调整。英文文档更详细地阐述了 RICH 设计范式的四个关键要素:意图、角色、对话和混合用户界面,强调了在 AGI 时代人机交互的演进。

变更

文件 变更摘要
docs/spec/introduce.en-US.md 更新多个图像链接,详细阐述 RICH 设计范式
docs/spec/introduce.zh-CN.md 替换文档中的图像链接

可能相关的 PR

诗歌

🐰 RICH 设计新篇章
意图角色话交融
界面进化不停歇
AI 时代绽光芒
兔子为你歌唱!


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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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 20, 2024

Preview is ready

Copy link

Walkthrough

This pull request updates image URLs in the documentation files introduce.en-US.md and introduce.zh-CN.md. The changes involve replacing existing image URLs with new ones, ensuring that the images are correctly displayed in the documentation.

Changes

File Summary
docs/spec/introduce.en-US.md, docs/spec/introduce.zh-CN.md Updated image URLs to new paths for better accessibility and display.

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: 2

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between a4f5fa6 and 4401927.

📒 Files selected for processing (2)
  • docs/spec/introduce.en-US.md (2 hunks)
  • docs/spec/introduce.zh-CN.md (2 hunks)
🧰 Additional context used
🪛 Markdownlint (0.37.0)
docs/spec/introduce.en-US.md

5-5: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


120-120: null
Images should have alternate text (alt text)

(MD045, no-alt-text)

docs/spec/introduce.zh-CN.md

5-5: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


120-120: null
Images should have alternate text (alt text)

(MD045, no-alt-text)

@@ -2,7 +2,7 @@
title: RICH 设计范式简介
---

![](https://mdn.alipayobjects.com/huamei_iwk9zp/afts/img/A*31g-RpB6F6UAAAAAAAAAAAAADgCCAQ/fmt.webp)
![](https://mdn.alipayobjects.com/huamei_iwk9zp/afts/img/A*48RLR41kwHIAAAAAAAAAAAAADgCCAQ/fmt.webp)
Copy link
Contributor

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

添加图片的替代文本以提高可访问性

为了确保文档的可访问性,建议为所有图片添加描述性的替代文本(alt text)。这对于使用屏幕阅读器的用户尤其重要。

建议按如下方式修改:

-![](https://mdn.alipayobjects.com/huamei_iwk9zp/afts/img/A*48RLR41kwHIAAAAAAAAAAAAADgCCAQ/fmt.webp)
+![RICH设计范式概览图](https://mdn.alipayobjects.com/huamei_iwk9zp/afts/img/A*48RLR41kwHIAAAAAAAAAAAAADgCCAQ/fmt.webp)

-![](https://mdn.alipayobjects.com/huamei_iwk9zp/afts/img/A*0xUFQoMAhiIAAAAAAAAAAAAADgCCAQ/original)
+![RICH设计范式应用示例](https://mdn.alipayobjects.com/huamei_iwk9zp/afts/img/A*0xUFQoMAhiIAAAAAAAAAAAAADgCCAQ/original)

Also applies to: 120-120

🧰 Tools
🪛 Markdownlint (0.37.0)

5-5: null
Images should have alternate text (alt text)

(MD045, no-alt-text)

@@ -2,7 +2,7 @@
title: RICH 设计范式简介
---

![](https://mdn.alipayobjects.com/huamei_iwk9zp/afts/img/A*31g-RpB6F6UAAAAAAAAAAAAADgCCAQ/fmt.webp)
![](https://mdn.alipayobjects.com/huamei_iwk9zp/afts/img/A*48RLR41kwHIAAAAAAAAAAAAADgCCAQ/fmt.webp)
Copy link
Contributor

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

添加图片的替代文本以提高可访问性

为了确保文档的可访问性,建议为所有图片添加描述性的替代文本(alt text)。这对于使用屏幕阅读器的用户尤其重要。

建议按如下方式修改:

-![](https://mdn.alipayobjects.com/huamei_iwk9zp/afts/img/A*48RLR41kwHIAAAAAAAAAAAAADgCCAQ/fmt.webp)
+![RICH设计范式概览图](https://mdn.alipayobjects.com/huamei_iwk9zp/afts/img/A*48RLR41kwHIAAAAAAAAAAAAADgCCAQ/fmt.webp)

-![](https://mdn.alipayobjects.com/huamei_iwk9zp/afts/img/A*0xUFQoMAhiIAAAAAAAAAAAAADgCCAQ/original)
+![RICH设计范式应用示例](https://mdn.alipayobjects.com/huamei_iwk9zp/afts/img/A*0xUFQoMAhiIAAAAAAAAAAAAADgCCAQ/original)

Also applies to: 120-120

🧰 Tools
🪛 Markdownlint (0.37.0)

5-5: null
Images should have alternate text (alt text)

(MD045, no-alt-text)

Copy link

size-limit report 📦

Path Size
dist/antdx.min.js 40.69 KB

Copy link

codecov bot commented Dec 20, 2024

Bundle Report

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

Detailed changes
Bundle name Size Change
antdx-array-push 156.23kB 404 bytes (0.26%) ⬆️

Copy link

cloudflare-workers-and-pages bot commented Dec 20, 2024

Deploying ant-design-x with  Cloudflare Pages  Cloudflare Pages

Latest commit: 7b74762
Status: ✅  Deploy successful!
Preview URL: https://e5b1b440.ant-design-x.pages.dev
Branch Preview URL: https://docs-fix-spec-introduce.ant-design-x.pages.dev

View logs

Copy link

codecov bot commented Dec 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.36%. Comparing base (49b6c89) to head (7b74762).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #377   +/-   ##
=======================================
  Coverage   91.36%   91.36%           
=======================================
  Files          66       66           
  Lines        1448     1448           
  Branches      383      383           
=======================================
  Hits         1323     1323           
  Misses        125      125           

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

@YumoImer
Copy link
Collaborator Author

Size Limit 本地执行 compile 没问题。先合并到 main 分支看看。

@YumoImer YumoImer merged commit 876f7d4 into main Dec 20, 2024
14 of 15 checks passed
@YumoImer YumoImer deleted the docs/fix-spec-introduce branch December 20, 2024 04:33
@coderabbitai coderabbitai bot mentioned this pull request Dec 23, 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