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

chore: update doc img #246

Merged
merged 1 commit into from
Nov 26, 2024
Merged

chore: update doc img #246

merged 1 commit into from
Nov 26, 2024

Conversation

Rain-1214
Copy link
Contributor

@Rain-1214 Rain-1214 commented Nov 26, 2024

fix: #245

Summary by CodeRabbit

  • 文档更新
    • 更新了《角色设计》文档的标题和内容结构,强调角色一致性的重要性。
    • 增加了具体场景的示例,如虚拟助手、客户服务等,提升用户信任。
    • 更新了文档中的视觉内容,替换了旧的图片链接。

Copy link
Contributor

coderabbitai bot commented Nov 26, 2024

📝 Walkthrough

Walkthrough

此次变更主要涉及文档 docs/spec/authentic-consistent.en-US.mddocs/spec/authentic-consistent.zh-CN.md 的内容组织和结构调整。文档标题更新,内容结构更为清晰,增加了关于角色一致性的指导和示例,强调了在不同场景中保持角色一致性的重要性。同时,更新了文档中的图片链接,以提升视觉表现。

Changes

文件路径 更改摘要
docs/spec/authentic-consistent.en-US.md 标题更改为“🎭 Role 角色设计”,更新图片链接,增加角色一致性指导和适用场景示例。
docs/spec/authentic-consistent.zh-CN.md 标题更改为“真实一致”,调整章节顺序,更新图片链接,扩展角色一致性指导和适用场景示例。

Assessment against linked issues

Objective Addressed Explanation
解决界面重复问题(#245

Suggested reviewers

  • YumoImer

Poem

在角色设计的舞台上,
一致性如影随形,
视觉与行为齐飞舞,
让用户信赖如春风。
角色的灵魂在这里,
真实与虚构共舞蹈。 🐇✨


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 Nov 26, 2024

Preview is ready

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

🧹 Outside diff range and nitpick comments (1)
docs/spec/authentic-consistent.zh-CN.md (1)

81-81: 建议为图片添加替代文本(alt text)以提高可访问性

为了确保文档的可访问性,建议为新添加的图片增加替代文本描述。这样可以帮助使用屏幕阅读器的用户更好地理解图片内容。

建议修改为:

-![](https://mdn.alipayobjects.com/huamei_iwk9zp/afts/img/A*Ao8DSZhMfIAAAAAAAAAAAAAADgCCAQ/original)
+![角色形象设计示例图](https://mdn.alipayobjects.com/huamei_iwk9zp/afts/img/A*Ao8DSZhMfIAAAAAAAAAAAAAADgCCAQ/original)
🧰 Tools
🪛 Markdownlint (0.35.0)

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

(MD045, no-alt-text)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between c530f09 and 974e183.

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

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

(MD045, no-alt-text)

docs/spec/authentic-consistent.zh-CN.md

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

(MD045, no-alt-text)

🔇 Additional comments (2)
docs/spec/authentic-consistent.en-US.md (1)

Line range hint 1-81: 文档结构清晰,内容组织合理

文档整体结构层次分明,内容详实,很好地阐述了角色设计中的真实一致性原则。各个部分的衔接自然,示例丰富,对用户理解和实践很有帮助。

🧰 Tools
🪛 Markdownlint (0.35.0)

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

(MD045, no-alt-text)

docs/spec/authentic-consistent.zh-CN.md (1)

81-81: 请确认此更改是否解决了重复PPT的问题

根据 Issue #245 的描述,原文档中存在重复的PPT幻灯片。请确认此图片更新是否已经解决了重复的问题。

✅ Verification successful

已确认此更改解决了重复PPT的问题

通过检查文档内容,现在文档中的图片链接都是不同的,包括:

  • A*--NqR78UDjUAAAAAAAAAAAAADgCCAQ/fmt.webp
  • A*0MTlRYAWlCQAAAAAAAAAAAAADgCCAQ/fmt.webp
  • A*Ao8DSZhMfIAAAAAAAAAAAAAADgCCAQ/original

每个图片都有唯一的标识符,不存在重复的PPT幻灯片。

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# 检查文档中是否还存在重复的图片链接
rg -i "fmt\.webp|original" docs/spec/authentic-consistent.zh-CN.md | sort | uniq -d

Length of output: 85


Script:

#!/bin/bash
# 获取文件内容以检查图片链接
cat docs/spec/authentic-consistent.zh-CN.md

Length of output: 1979


Script:

#!/bin/bash
# 检查 Issue #245 的内容以了解重复PPT的具体问题
gh issue view 245

Length of output: 501

🧰 Tools
🪛 Markdownlint (0.35.0)

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

(MD045, no-alt-text)

@@ -78,4 +78,4 @@ title: 真实一致
- **声音音色**
- **行为动作**

![](https://mdn.alipayobjects.com/huamei_iwk9zp/afts/img/A*0MTlRYAWlCQAAAAAAAAAAAAADgCCAQ/fmt.webp)
![](https://mdn.alipayobjects.com/huamei_iwk9zp/afts/img/A*Ao8DSZhMfIAAAAAAAAAAAAAADgCCAQ/original)
Copy link
Contributor

Choose a reason for hiding this comment

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

💡 Codebase verification

需要为中英文文档中的图片添加替代文本

这两个图片出现在中英文对照文档中是正常的,不属于 #245 issue 提到的重复问题。但是两个文档中的图片都缺少替代文本,建议添加以提高可访问性:

  • docs/spec/authentic-consistent.en-US.md: 添加英文替代文本
-![](https://mdn.alipayobjects.com/huamei_iwk9zp/afts/img/A*Ao8DSZhMfIAAAAAAAAAAAAAADgCCAQ/original)
+![Behavioral actions example](https://mdn.alipayobjects.com/huamei_iwk9zp/afts/img/A*Ao8DSZhMfIAAAAAAAAAAAAAADgCCAQ/original)
  • docs/spec/authentic-consistent.zh-CN.md: 添加中文替代文本
-![](https://mdn.alipayobjects.com/huamei_iwk9zp/afts/img/A*Ao8DSZhMfIAAAAAAAAAAAAAADgCCAQ/original)
+![行为动作示例](https://mdn.alipayobjects.com/huamei_iwk9zp/afts/img/A*Ao8DSZhMfIAAAAAAAAAAAAAADgCCAQ/original)
🔗 Analysis chain

需要添加图片替代文本并确认重复问题

为了提高文档的可访问性,建议为图片添加替代文本(alt text)。同时,请确认这张图片是否解决了 issue #245 中提到的PPT重复问题。

建议修改为:

-![](https://mdn.alipayobjects.com/huamei_iwk9zp/afts/img/A*Ao8DSZhMfIAAAAAAAAAAAAAADgCCAQ/original)
+![角色形象设计示例](https://mdn.alipayobjects.com/huamei_iwk9zp/afts/img/A*Ao8DSZhMfIAAAAAAAAAAAAAADgCCAQ/original)

Let me verify if this image appears in any other locations and check the context around these occurrences to understand if they are legitimate dual-language documentation or actual duplicates.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# 检查文档中是否还存在重复的图片链接
rg -i "A\*Ao8DSZhMfIAAAAAAAAAAAAAADgCCAQ" docs/

Length of output: 329


Script:

#!/bin/bash
# Check the context around the image in both files
echo "=== English version context ==="
rg -B 2 -A 2 "A\*Ao8DSZhMfIAAAAAAAAAAAAAADgCCAQ" docs/spec/authentic-consistent.en-US.md

echo -e "\n=== Chinese version context ==="
rg -B 2 -A 2 "A\*Ao8DSZhMfIAAAAAAAAAAAAAADgCCAQ" docs/spec/authentic-consistent.zh-CN.md

Length of output: 557

🧰 Tools
🪛 Markdownlint (0.35.0)

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

(MD045, no-alt-text)

Copy link

codecov bot commented Nov 26, 2024

Bundle Report

Bundle size has no change ✅

@YumoImer
Copy link
Collaborator

非常感谢!

Copy link

codecov bot commented Nov 26, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.13%. Comparing base (c530f09) to head (974e183).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #246   +/-   ##
=======================================
  Coverage   91.13%   91.13%           
=======================================
  Files          66       66           
  Lines        1421     1421           
  Branches      378      379    +1     
=======================================
  Hits         1295     1295           
  Misses        126      126           

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

@YumoImer YumoImer merged commit 1dc5a44 into ant-design:main Nov 26, 2024
11 checks passed
@Rain-1214 Rain-1214 deleted the bugfix/245 branch November 26, 2024 09:22
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.

Role-角色设计-真实一致 界面有两张PPT重复了
2 participants