-
-
Notifications
You must be signed in to change notification settings - Fork 77
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
Conversation
📝 WalkthroughWalkthrough此次变更主要涉及文档 Changes
Assessment against linked issues
Suggested reviewers
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this 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
📒 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) |
There was a problem hiding this comment.
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)
Bundle ReportBundle size has no change ✅ |
非常感谢! |
Codecov ReportAll modified and coverable lines are covered by tests ✅
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. |
fix: #245
Summary by CodeRabbit