Skip to content

docs: add API_BASE_URL troubleshooting section for agent client#50

Open
fwseyi wants to merge 2 commits into
emrekayat:mainfrom
fwseyi:docs/api-base-url-troubleshooting
Open

docs: add API_BASE_URL troubleshooting section for agent client#50
fwseyi wants to merge 2 commits into
emrekayat:mainfrom
fwseyi:docs/api-base-url-troubleshooting

Conversation

@fwseyi

@fwseyi fwseyi commented Jun 28, 2026

Copy link
Copy Markdown

Summary

Adds a concise troubleshooting section to README.MD to help contributors quickly diagnose agent-client failures caused by a wrong API_BASE_URL or a stopped API server.

Changes

README.MD

Added ## Troubleshooting section at the end covering:

  1. How to confirm the API server is running (npm run dev --workspace @query402/api)
  2. How to set API_BASE_URL for local development (env export + .env file example)
  3. Copy-pasteable command to run the agent demo (npm run demo --workspace @query402/agent-client)
  4. Note to never commit real private keys

Notes

  • Documentation-only change — no runtime code modified
  • npm run format:check passes
  • No secrets or real private keys included

Closes #34

@vercel

vercel Bot commented Jun 28, 2026

Copy link
Copy Markdown

@fwseyi is attempting to deploy a commit to the emrekayat's projects Team on Vercel.

A member of the Team first needs to authorize it.

@drips-wave

drips-wave Bot commented Jun 28, 2026

Copy link
Copy Markdown

@fwseyi Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits.

You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀

Learn more about application limits

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.

Document API_BASE_URL troubleshooting for the agent client

1 participant