Skip to content

docs(ide): refresh TuyaOpen IDE tutorials — calibrated EN/ZH text, sp… - #250

Merged
adwuard merged 1 commit into
masterfrom
docs/update-image
Jul 31, 2026
Merged

docs(ide): refresh TuyaOpen IDE tutorials — calibrated EN/ZH text, sp…#250
adwuard merged 1 commit into
masterfrom
docs/update-image

Conversation

@jianning773

Copy link
Copy Markdown
Collaborator

…lit locale screenshots, rendering fixes

Re-align the IDE tutorial pages (docs/tutorials/_tuyaopen-ide-*.md and the zh/ mirrors) with the finalized 3.0 source docs and the actual IDE UI, in both English and 简体中文.

Content (EN + ZH):

  • Install: add an "Install Git" section; rework the manual install to the official-site flow (Install Extension → Download .vsix); bump the .vsix version 0.1.1 → 0.1.5.
  • Practice 1–3: calibrate every IDE button/menu label against the IDE i18n source (en.ts / zh-CN.ts) so docs match the UI exactly — Boards, Compile / Firmware Operations, New Project with This Board, Demos, Cloud IoT/Agent Dev, Licenses / Key Management, Mini App Panel Dev, Build MiniApp, Upload to Cloud, Rebind MiniApp, Get 2 Free Licenses, etc.
  • Practice 3: add the DP-cooperation intro line; rewrite Step 3 to 4 steps; add a new Step 4 "Bind the mini-app to the product".
  • Practice 2: simplify the "Create project" flow (Step 5 = copy the PID).

Screenshots:

  • English pages now use their own English-UI screenshots.
  • Chinese pages now use their own Chinese-UI screenshots (-zh set), sourced from the finalized Chinese doc. EN and ZH previously shared one image set.

Shared TutorialShell rendering:

  • Markdown code blocks now render as native Docusaurus CodeBlocks (copy button + theme-adaptive + syntax highlighting) via an MDXProvider wrap.
  • Replace the hardcoded dark code/pre/figure backgrounds with theme-adaptive styles so light mode no longer shows dark blocks.
  • Center tutorial images; hide the redundant figcaption (alt stays on ).

Nav: add zh entries for the new Install-Git and Practice-3 Step-4 sections.

Verified: npm run build passes for both en and zh locales.

…lit locale screenshots, rendering fixes

Re-align the IDE tutorial pages (docs/tutorials/_tuyaopen-ide-*.md and the
zh/ mirrors) with the finalized 3.0 source docs and the actual IDE UI, in
both English and 简体中文.

Content (EN + ZH):
- Install: add an "Install Git" section; rework the manual install to the
  official-site flow (Install Extension → Download .vsix); bump the .vsix
  version 0.1.1 → 0.1.5.
- Practice 1–3: calibrate every IDE button/menu label against the IDE i18n
  source (en.ts / zh-CN.ts) so docs match the UI exactly — Boards, Compile /
  Firmware Operations, New Project with This Board, Demos, Cloud IoT/Agent
  Dev, Licenses / Key Management, Mini App Panel Dev, Build MiniApp, Upload
  to Cloud, Rebind MiniApp, Get 2 Free Licenses, etc.
- Practice 3: add the DP-cooperation intro line; rewrite Step 3 to 4 steps;
  add a new Step 4 "Bind the mini-app to the product".
- Practice 2: simplify the "Create project" flow (Step 5 = copy the PID).

Screenshots:
- English pages now use their own English-UI screenshots.
- Chinese pages now use their own Chinese-UI screenshots (-zh set), sourced
  from the finalized Chinese doc. EN and ZH previously shared one image set.

Shared TutorialShell rendering:
- Markdown code blocks now render as native Docusaurus CodeBlocks (copy
  button + theme-adaptive + syntax highlighting) via an MDXProvider wrap.
- Replace the hardcoded dark code/pre/figure backgrounds with theme-adaptive
  styles so light mode no longer shows dark blocks.
- Center tutorial images; hide the redundant figcaption (alt stays on <img>).

Nav: add zh entries for the new Install-Git and Practice-3 Step-4 sections.

Verified: npm run build passes for both en and zh locales.
@adwuard
adwuard merged commit 27d48c7 into master Jul 31, 2026
2 checks passed
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