Skip to content

docs: update Studio quick start guide and remote access documentation - #43

Merged
junlin-luo-spacemit merged 4 commits into
mainfrom
docs/studio-quick-start-updates
Jul 30, 2026
Merged

docs: update Studio quick start guide and remote access documentation#43
junlin-luo-spacemit merged 4 commits into
mainfrom
docs/studio-quick-start-updates

Conversation

@junlin-luo-spacemit

Copy link
Copy Markdown
Collaborator

Changes

This PR updates the Studio documentation with refreshed screenshots and improved content:

Updated Screenshots

  • Initial setup UI screenshots with latest Studio interface
  • Device management page with current design
  • Remote gateway configuration screens (setup, status, connection)

Documentation Updates

  • Remote Access Guide (dev_tools/remote_access.md): Clearer instructions for remote gateway configuration
  • Settings Guide (settings.md): Updated to reflect current UI
  • Dev Tools Index (dev_tools/index.md): Improved navigation and structure

Technical Details

  • All changes synchronized across both zh/ and en/ versions
  • Images updated: initial.png, device.png, remote_gateway.png, remote_gateway_00.png, remote_gateway_01.png, remote_gateway_02.png
  • 18 files changed with consistent formatting and content parity

Testing

  • Verified all images render correctly
  • Checked zh/en content parity
  • Validated markdown formatting

- Separate toolbar and context menu descriptions for clarity
- Add missing context menu actions: Copy Path, Open in Terminal, Rename, Delete
- Fix toolbar button descriptions to match actual UI
- Update both Chinese and English versions for parity
- Update remote_gateway.png with English UI
- Update tool_00.png with English UI
- Updated initial setup screenshots with latest Studio UI
- Enhanced remote gateway configuration images
- Improved device management screenshots
- Updated remote access documentation with clearer instructions
- Synchronized changes across zh/ and en/ versions
@junlin-luo-spacemit
junlin-luo-spacemit merged commit 93adac2 into main Jul 30, 2026
2 checks passed
@github-actions

Copy link
Copy Markdown

📄 Bilingual Docs Check

⚠️ Some files need attention

Changed files in this PR

File EN ZH
studio/static/device.png
studio/static/initial.png
studio/static/remote_gateway.png
studio/static/remote_gateway_00.png
studio/static/remote_gateway_01.png
studio/static/remote_gateway_02.png
studio/user_guide/dev_tools/index.md
studio/user_guide/dev_tools/remote_access.md
studio/user_guide/settings.md

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

⚠️ Heading count mismatch (possible structural drift)

  • studio/user_guide/dev_tools/remote_access.md: EN has 6 heading(s), ZH has 5 heading(s)

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

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

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

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

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

  • No callouts (NOTE / WARNING / TIP) found in a multi-section document. Consider highlighting critical information with blockquotes or admonition syntax.

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

  • No callouts (NOTE / WARNING / TIP) found in a multi-section document. Consider highlighting critical information with blockquotes or admonition syntax.

@junlin-luo-spacemit
junlin-luo-spacemit deleted the docs/studio-quick-start-updates branch July 30, 2026 03:31
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