Skip to content

Add a Troubleshooting page to Getting Started - #11

Merged
david-hummingbot merged 1 commit into
mainfrom
docs/troubleshooting-page
Sep 16, 2026
Merged

david-hummingbot merged 1 commit into
mainfrom
docs/troubleshooting-page

Conversation

@david-hummingbot

Copy link
Copy Markdown
Contributor

Summary

  • Adds getting-started/troubleshooting.mdx as the last page in Getting Started, consolidating Condor ↔ Hummingbot API connectivity, Tailscale, and message-broker-security guidance that was previously buried at the bottom of the install guide.
  • A standalone "Connection issues" section leads (most common failure category), followed by less-common startup/Telegram/Docker/data issues grouped into themed accordions, then a short broker-security summary linking to hummingbot.org/hummingbot-api/broker-security, then the recovery command toolkit.
  • Additional scenarios (Tailscale device collisions, CONFIG_PASSWORD mismatches, port conflicts, corrupted persistence, stale broker credentials, DockerService init failures, etc.) were found by scanning the condor and hummingbot-api main branches directly and verifying each against source before writing.
  • installing.mdx and the orphaned installation.mdx now point to the new page instead of duplicating the content.
  • credentials.mdx gets a one-line addition: invalid API key errors surface the exchange's own error text.

Test plan

  • mintlify broken-links — no broken links
  • Verified new/updated error messages and behavior against condor and hummingbot-api source (main) before writing
  • Previewed all touched pages locally via mintlify dev

🤖 Generated with Claude Code

Consolidates Condor <-> Hummingbot API connectivity, Tailscale, and
broker security guidance into one dedicated page instead of burying it
at the bottom of the install guide. Scenarios are sourced from the
condor and hummingbot-api main branches (setup flow, make doctor
checks, and runtime error handling), not just what was already
documented.

Also adds a one-line note to credentials.mdx about invalid API key
errors surfacing the exchange's own error text.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@david-hummingbot
david-hummingbot merged commit cd299be into main Sep 16, 2026
1 check passed
@david-hummingbot
david-hummingbot deleted the docs/troubleshooting-page branch September 16, 2026 10:24
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