Skip to content

Commit 9b9200a

Browse files
Add documentation for example application
- Document the example/ directory in the repository overview - Explain the purpose as both reference implementation and verification tool - Highlight key features: ES module compatibility, TypeScript config, build processes - Position as a template for developers building their own applications Co-authored-by: openhands <openhands@all-hands.dev>
1 parent 060c17c commit 9b9200a

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

.openhands/microagents/repo.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,4 +80,17 @@ This client is intended for developers who want to:
8080
- Integrate OpenHands capabilities into existing TypeScript/JavaScript applications
8181
- Develop custom frontends for the OpenHands Agent Server
8282

83-
The client abstracts away the complexity of HTTP requests, WebSocket management, and API authentication, providing a clean, type-safe interface for all OpenHands Agent Server functionality.
83+
The client abstracts away the complexity of HTTP requests, WebSocket management, and API authentication, providing a clean, type-safe interface for all OpenHands Agent Server functionality.
84+
85+
## Example Application
86+
87+
The `example/` directory contains a React application built with Vite that demonstrates how to integrate the TypeScript SDK into a modern web application. This example serves as both a reference implementation and a verification tool to ensure the SDK works correctly in browser environments.
88+
89+
The example application showcases:
90+
- Proper SDK integration with ES module compatibility
91+
- TypeScript configuration for client-side development
92+
- Build processes that compile the SDK before running the application
93+
- Import verification of all major SDK classes and enums
94+
- Modern React development patterns with Vite tooling
95+
96+
This provides developers with a working template for building their own applications using the OpenHands Agent Server TypeScript Client.

0 commit comments

Comments
 (0)