Add a troubleshooting guide for common API connection failures
Description
Contributors hitting CORS, wrong NEXT_PUBLIC_STABLEROUTE_API_BASE values, or a paused router get raw errors from src/lib/apiClient.ts with no documented remedy.
Requirements and context
- Repository scope: StableRoute-Org/Stableroute-frontend only.
- Cover misconfigured base URLs, CORS rejections, timeouts, and 401/403 responses.
- Map each symptom to the module in
src/lib that produced it.
- Link the guide from
README.md and .env.example.
Suggested execution
- Fork the repo and create a branch
git checkout -b docs/docs-add-a-troubleshooting-guide
- Write code in:
docs/TROUBLESHOOTING.md
- Write comprehensive tests in:
src/lib/__tests__/config.test.ts
- Add documentation:
docs/TROUBLESHOOTING.md
Test and commit
- Run
npm run lint, npm test, npm run build
- Cover edge cases; include test output
Example commit message
docs(support): add an API connection troubleshooting guide
Guidelines
- Minimum 95 percent test coverage for impacted modules
- Clear documentation
- Timeframe: 96 hours.
Community & contribution rewards
- 💬 Join the StableRoute community on Discord: https://discord.gg/37aCpusvx
- ⭐ This is a GrantFox OSS / Official Campaign task and may be rewarded. When your PR is merged you'll be prompted to rate the project — a 5-star rating is much appreciated.
Add a troubleshooting guide for common API connection failures
Description
Contributors hitting CORS, wrong
NEXT_PUBLIC_STABLEROUTE_API_BASEvalues, or a paused router get raw errors fromsrc/lib/apiClient.tswith no documented remedy.Requirements and context
src/libthat produced it.README.mdand.env.example.Suggested execution
git checkout -b docs/docs-add-a-troubleshooting-guidedocs/TROUBLESHOOTING.mdsrc/lib/__tests__/config.test.tsdocs/TROUBLESHOOTING.mdTest and commit
npm run lint,npm test,npm run buildExample commit message
docs(support): add an API connection troubleshooting guideGuidelines
Community & contribution rewards