chore: adjust i18n docs format #4185
Conversation
Lsnsh
requested review from
ezailWang,
loatheb,
sidmorizon,
originalix and
huhuanming
as code owners
Review or Edit in CodeSandboxOpen the branch in Web Editor • VS Code • Insiders |
PR Summary
|
Lsnsh
force-pushed
the
fix/adjust-i18n-docs-format
branch
from
1ba3241
to
10bc2a9
Compare
Lsnsh
force-pushed
the
fix/adjust-i18n-docs-format
branch
from
10bc2a9
to
1d0c7fa
Compare
Walkthrough本次更改涉及多个语言的i18n文档，主要集中在环境配置和开发指令的清晰度和结构上。各语言的README文件都进行了格式调整，移除了代码块标记，使安装命令更易读。此外，Android项目配置部分被重新组织，明确了社区和官方开发者的不同方法。文档的目录结构和依赖管理说明也得到了改善，FAQ部分扩展了常见问题的解决方案。 Changes
Sequence Diagram(s)sequenceDiagram
participant Developer
participant Environment
participant Repository
participant Dependencies
Developer->>Environment: 配置环境
Developer->>Repository: 拉取最新代码
Repository->>Dependencies: 安装JavaScript依赖
Dependencies-->>Developer: 依赖安装完成
Developer->>Environment: 启动开发模式
Environment-->>Developer: 开发环境准备就绪
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 (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 5
🧹 Outside diff range comments (7)
docs/i18n/README.zh-cn.md (1)
Line range hint
1-24: 建议为所有代码块指定语言为了提高文档的可读性和代码高亮效果，建议为所有命令行代码块添加
bash或相应的语言标识。例如，在文档中的其他命令行代码块也应该指定语言：
-yarn workspace @onekeyhq/web add axios +```bash +yarn workspace @onekeyhq/web add axios +```🧰 Tools
🪛 Markdownlint
14-14: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
docs/i18n/README.jp.md (4)
Line range hint
31-37: 建议补充配置说明的重要性为了帮助开发者更好地理解，建议添加以下内容：
- 说明为什么需要这些配置
- 缺少配置可能带来的影响
- 如何验证配置是否正确
🧰 Tools
🪛 Markdownlint
14-14: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
Line range hint
47-53: 建议完善目录结构说明为提高文档的实用性，建议：
- 为每个目录添加具体的使用示例
- 说明各个包之间的依赖关系
- 补充每个目录下重要文件的用途
🧰 Tools
🪛 Markdownlint
14-14: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
Line range hint
55-61: 建议补充依赖安装的常见问题为了减少开发者遇到的困扰，建议添加：
- 常见错误及解决方案
- 不同操作系统的特殊注意事项
- 版本兼容性说明
🧰 Tools
🪛 Markdownlint
14-14: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
Line range hint
63-72: 建议扩充FAQ内容为了提供更全面的帮助，建议增加以下常见问题：
- 开发环境配置问题
- 编译打包相关问题
- 调试技巧
- 性能优化建议
🧰 Tools
🪛 Markdownlint
14-14: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
docs/i18n/README.it.md (2)
Line range hint
35-42: 建议完善 Android 配置说明社区开发者配置部分需要补充以下信息：
keys.c文件的具体结构- 默认选项的使用限制说明
- 可能遇到的 API 限制具体有哪些
🧰 Tools
🪛 Markdownlint
14-14: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
Line range hint
82-86: 建议扩展环境问题排查步骤为了帮助开发者更好地解决环境问题，建议：
- 详细列出
yarn clean会清理哪些内容- 添加清理后的验证步骤
- 补充常见错误的具体表现和解决方案
需要我帮您编写详细的故障排除指南吗？
🧰 Tools
🪛 Markdownlint
14-14: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
📒 Files selected for processing (5)
docs/i18n/README.de.md(1 hunks)docs/i18n/README.fr.md(1 hunks)docs/i18n/README.it.md(1 hunks)docs/i18n/README.jp.md(1 hunks)docs/i18n/README.zh-cn.md(1 hunks)
🧰 Additional context used
🪛 Markdownlint
docs/i18n/README.de.md
14-14: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
docs/i18n/README.fr.md
14-14: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
docs/i18n/README.it.md
14-14: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
docs/i18n/README.jp.md
14-14: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
docs/i18n/README.zh-cn.md
14-14: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🔇 Additional comments (2)
docs/i18n/README.de.md (1)
Line range hint 1-24: 文档结构清晰，内容完整
文档组织合理，包含了环境配置、开发指令和项目结构等重要信息，对开发者很有帮助。安装步骤和故障排除指南也很详细。
🧰 Tools
🪛 Markdownlint
14-14: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
docs/i18n/README.fr.md (1)
Line range hint 1-24: 文档结构清晰，内容完整
文档组织合理，包含了环境配置、开发指南、目录结构和常见问题等重要部分。安装步骤和工作区设置说明清晰明了，对开发者很友好。
🧰 Tools
🪛 LanguageTool
[typographical] ~10-~10: Caractère d’apostrophe incorrect.
Context: ...s le répertoire racine avec la commande yarn. Installer toutes les dépendance...
(APOS_INCORRECT)
🪛 Markdownlint
14-14: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
Use correct base branch(
x) and change PR branch name.Adjust i18n related docs format, eg:
Before change:
https://github.com/OneKeyHQ/app-monorepo/blob/064fca17f01c76b26a1a6813a42cd6a7c9adc972/docs/i18n/README.zh-cn.md
After change:
https://github.com/OneKeyHQ/app-monorepo/blob/1ba3241b7d039da5dd09470633ffd6af2f2b0168/docs/i18n/README.zh-cn.md
Summary by CodeRabbit
yarn命令管理依赖。