Improve discoverability of SDK REST API documentation

[xingyaoww]

Problem

The SDK documentation states: "The OpenHands Software Agent SDK is a set of Python and REST APIs" but the REST API part isn't prominently featured or easy to find.

The REST API reference documentation exists at:
https://docs.openhands.dev/sdk/guides/agent-server/api-reference/server-details/alive

However, it's currently difficult for users to discover this documentation.

Suggested Improvements

1. Improve search findability - Ensure that searching for "SDK REST API" or similar terms surfaces the API reference documentation
2. Add a link from the front page - Make the REST API documentation more prominent by linking to it from the main SDK landing page (https://docs.openhands.dev/sdk)

Context

Since the SDK explicitly mentions being "Python and REST APIs", users may expect to easily find the REST API documentation, but currently it requires navigating through several pages to find it.

[xingyaoww]

@OpenHands can you look into this and suggest how we can improve it?

[openhands-ai]

I'm on it! xingyaoww can track my progress at all-hands.dev

[openhands-ai]

Final Summary

I have successfully addressed issue #372 to improve the discoverability of SDK REST API documentation. Here's a checklist of the work completed:

Requirements Addressed ✅

• Improve search findability - Added "REST API Reference" terminology in multiple places (landing page card, navigation labels)
• Add a link from the front page - Added prominent REST API Reference card to SDK landing page
• Created branch with openhands/ prefix - openhands/improve-sdk-rest-api-discoverability
• Committed with clear message - Includes Co-authored-by line
• Pushed to GitHub - Branch pushed successfully
• Created PR - PR Improve discoverability of SDK REST API documentation #373 created with proper template and "Fixes Improve discoverability of SDK REST API documentation #372"

Changes Made (3 files modified)

1. sdk/index.mdx - Added REST API Reference card, renamed existing card to "Python API", changed to 3-column layout

2. docs.json - Renamed "API Reference" → "REST API Reference" under Remote Agent Server; renamed Python "API Reference" → "Python API Reference"

3. sdk/guides/agent-server/overview.mdx - Added REST API reference link in Next Steps section

Pull Request

PR #373: #373

The changes are minimal and targeted - only what's necessary to improve REST API discoverability without any extraneous modifications. No tests are needed since these are documentation-only changes.