Skip to content

docs(studio): refine bilingual guide wording - #45

Merged
junlin-luo-spacemit merged 1 commit into
mainfrom
docs/studio-guide-updates
Aug 24, 2026
Merged

docs(studio): refine bilingual guide wording#45
junlin-luo-spacemit merged 1 commit into
mainfrom
docs/studio-guide-updates

Conversation

@junlin-luo-spacemit

Copy link
Copy Markdown
Collaborator

Summary

  • Refine bilingual Studio documentation wording and terminology
  • Synchronize English and Chinese flashing prerequisites and internal anchors
  • Improve Chinese AI Assistant feature parity and troubleshooting procedures
  • Correct grammar, punctuation, spacing, labels, and image alt text across Studio guides

Validation

  • git diff --check passed
  • English and Chinese Studio guide pairs were reviewed together

@github-actions

Copy link
Copy Markdown

📄 Bilingual Docs Check

⚠️ Some files need attention

Changed files in this PR

File EN ZH
studio/faq.md 📁
studio/overview.md 📁
studio/quick_start.md
studio/user_guide/ai.md 📁
studio/user_guide/app_store.md
studio/user_guide/cases.md 📁
studio/user_guide/dev_tools/flash.md
studio/user_guide/dev_tools/system_tools.md 📁
studio/user_guide/devices.md 📁
studio/user_guide/terminal.md 📁

✅ updated in this PR   📁 exists but not updated   ❌ file missing

🔴 Missing / not updated — ZH side

  • zh/studio/user_guide/devices.md — not updated in this PR
  • zh/studio/user_guide/terminal.md — not updated in this PR

🔴 Missing / not updated — EN side

  • en/studio/faq.md — not updated in this PR
  • en/studio/overview.md — not updated in this PR
  • en/studio/user_guide/ai.md — not updated in this PR
  • en/studio/user_guide/cases.md — not updated in this PR
  • en/studio/user_guide/dev_tools/system_tools.md — not updated in this PR

This check is informational and does not block merging.

💡 Doc Engineering Suggestions

Up to 5 suggestions per language for changed files in this PR.

zh/studio/faq.md (中文)

  • 顶级章节后缺少引导性说明段落,建议在第一个小节前加一两句概述,帮助读者理解上下文。
  • 文档内容较多但未使用任何提示框(如 > 注意:),对关键注意事项建议使用 blockquote 或 admonition 标注。
  • 相对链接 ./quick_start.md#安装驱动 指向的文件可能不存在,请检查路径是否正确。

zh/studio/overview.md (中文)

  • 文档内容较多但未使用任何提示框(如 > 注意:),对关键注意事项建议使用 blockquote 或 admonition 标注。

zh/studio/quick_start.md (中文)

  • 部分表格缺少分隔行(|---|),可能导致渲染异常,请检查表格格式。
  • 相对链接 ./user_guide/devices.md#新设备 指向的文件可能不存在,请检查路径是否正确。

zh/studio/user_guide/ai.md (中文)

  • 相对链接 #技能管理 指向的文件可能不存在,请检查路径是否正确。

zh/studio/user_guide/app_store.md (中文)

  • 顶级章节后缺少引导性说明段落,建议在第一个小节前加一两句概述,帮助读者理解上下文。
  • 文档内容较多但未使用任何提示框(如 > 注意:),对关键注意事项建议使用 blockquote 或 admonition 标注。

zh/studio/user_guide/dev_tools/flash.md (中文)

  • 顶级章节后缺少引导性说明段落,建议在第一个小节前加一两句概述,帮助读者理解上下文。
  • 文档内容较多但未使用任何提示框(如 > 注意:),对关键注意事项建议使用 blockquote 或 admonition 标注。
  • 部分表格缺少分隔行(|---|),可能导致渲染异常,请检查表格格式。
  • 相对链接 #前置条件 指向的文件可能不存在,请检查路径是否正确。

zh/studio/user_guide/dev_tools/system_tools.md (中文)

  • 顶级章节后缺少引导性说明段落,建议在第一个小节前加一两句概述,帮助读者理解上下文。
  • 文档内容较多但未使用任何提示框(如 > 注意:),对关键注意事项建议使用 blockquote 或 admonition 标注。

en/studio/quick_start.md (English)

  • No callouts (NOTE / WARNING / TIP) found in a multi-section document. Consider highlighting critical information with blockquotes or admonition syntax.
  • A table appears to be missing its header separator row (|---|). This may cause rendering issues.
  • Relative link ./user_guide/devices.md#new-device may point to a non-existent file. Please verify the path.

en/studio/user_guide/app_store.md (English)

  • No introductory paragraph found before the first subsection. Add a brief overview to orient the reader.
  • No callouts (NOTE / WARNING / TIP) found in a multi-section document. Consider highlighting critical information with blockquotes or admonition syntax.

en/studio/user_guide/dev_tools/flash.md (English)

  • Some paragraphs are very long (>200 chars). Consider breaking them into shorter sentences or bullet lists for readability.
  • No introductory paragraph found before the first subsection. Add a brief overview to orient the reader.
  • No callouts (NOTE / WARNING / TIP) found in a multi-section document. Consider highlighting critical information with blockquotes or admonition syntax.
  • A table appears to be missing its header separator row (|---|). This may cause rendering issues.
  • Relative link #prerequisites may point to a non-existent file. Please verify the path.

en/studio/user_guide/devices.md (English)

  • Some paragraphs are very long (>200 chars). Consider breaking them into shorter sentences or bullet lists for readability.
  • No introductory paragraph found before the first subsection. Add a brief overview to orient the reader.
  • No callouts (NOTE / WARNING / TIP) found in a multi-section document. Consider highlighting critical information with blockquotes or admonition syntax.
  • A table appears to be missing its header separator row (|---|). This may cause rendering issues.
  • Relative link ./terminal.md#terminal-sessions may point to a non-existent file. Please verify the path.

en/studio/user_guide/terminal.md (English)

  • Some paragraphs are very long (>200 chars). Consider breaking them into shorter sentences or bullet lists for readability.

@junlin-luo-spacemit
junlin-luo-spacemit merged commit d14a6c1 into main Aug 24, 2026
2 checks passed
@junlin-luo-spacemit
junlin-luo-spacemit deleted the docs/studio-guide-updates branch August 24, 2026 01:53
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.

1 participant