Skip to content

Update jtag_debug_user_guide - #46

Open
lz-bro wants to merge 1 commit into
mainfrom
update-debug-user-guide
Open

Update jtag_debug_user_guide#46
lz-bro wants to merge 1 commit into
mainfrom
update-debug-user-guide

Conversation

@lz-bro

@lz-bro lz-bro commented Aug 27, 2026

Copy link
Copy Markdown
Collaborator

No description provided.

@lz-bro
lz-bro requested a review from zqb-all as a code owner August 27, 2026 01:36
@github-actions

Copy link
Copy Markdown

📄 Bilingual Docs Check

✅ All changed files have both zh and en counterparts

Changed files in this PR

File EN ZH
user_guide/jtag_debug_user_guide.md

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

No parity issues detected. 🎉


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/user_guide/jtag_debug_user_guide.md (中文)

  • 建议为代码块添加语言标签(如```bash```yaml),方便读者识别和语法高亮。
  • 文档缺少 frontmatter(--- 块),建议补充 sidebar_position 等元数据。
  • 顶级章节后缺少引导性说明段落,建议在第一个小节前加一两句概述,帮助读者理解上下文。
  • 文档内容较多但未使用任何提示框(如 > 注意:),对关键注意事项建议使用 blockquote 或 admonition 标注。

en/user_guide/jtag_debug_user_guide.md (English)

  • Add a language tag to fenced code blocks (e.g. ```bash, ```yaml) for syntax highlighting and readability.
  • Document is missing frontmatter (--- block). Consider adding sidebar_position and other metadata.
  • 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.

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