Skip to content

[DX] Add troubleshooting documentation - #38

Closed
keithfx999 wants to merge 1 commit into
TencentCloudAgentRuntime:mainfrom
keithfx999:fix/dx-age47-add-troubleshooting-docs
Closed

keithfx999 wants to merge 1 commit into
TencentCloudAgentRuntime:mainfrom
keithfx999:fix/dx-age47-add-troubleshooting-docs

Conversation

@keithfx999

Copy link
Copy Markdown
Member

Multica Issue

  • Issue ID: AGE-47
  • Priority: P1
  • Type: DX Auto Fix

Problem

The ags-cli repository has no troubleshooting documentation. When users encounter authentication failures, network timeouts, backend capability mismatches, or other common errors, there is no official reference to guide them. This is a significant pain point for new developers getting started with AGS CLI.

Changes

  • Add docs/troubleshooting.md — comprehensive English troubleshooting guide
  • Add docs/troubleshooting-zh.md — Chinese translation of the troubleshooting guide
  • Update README.md — add a Troubleshooting section linking to the guides

Acceptance Criteria

  • Troubleshooting documentation exists in the repository
  • Covers authentication failures (E2B API Key and Cloud AKSK)
  • Covers network timeouts and region issues
  • Covers backend capability mismatches ("not supported" errors)
  • Each failure scenario provides clear "next step" actions
  • Both English and Chinese versions provided (matching existing docs pattern)
  • README links to the troubleshooting guide

Validation

  • Build passed (make build succeeds)
  • Docs manually checked for accuracy against codebase error messages
  • No code changes — docs only

Risk

Docs-only change. No code modifications, no compatibility risk. Adds new files and a README section without altering existing content.

Automation Note

This PR was generated by Agent Sandbox DX Auto Fix Agent based on multica issue AGE-47.

Add comprehensive troubleshooting guides (English + Chinese) covering:
- Authentication failures (E2B API Key, Cloud AKSK)
- Backend capability mismatches
- Network and region issues
- Port forwarding problems
- Configuration issues
- Instance/sandbox errors
- Mobile sandbox issues
- Quick reference error table

Also add a Troubleshooting section to README.md linking to the guides.

Ref: multica issue AGE-47
Co-authored-by: multica-agent <github@multica.ai>
@keithfx999 keithfx999 closed this May 15, 2026
@keithfx999
keithfx999 deleted the fix/dx-age47-add-troubleshooting-docs branch May 21, 2026 12:27
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