This guide provides an overview of the key documentation resources available in the OpenHands repository. Whether you’re looking to contribute, understand the architecture, or work on specific components, these resources will help you navigate the codebase effectively.
/README.md
)
The primary entry point for understanding OpenHands, including features and basic setup instructions.
/Development.md
)
Comprehensive guide for developers working on OpenHands, including setup, requirements, and development workflows.
/CONTRIBUTING.md
)
Essential information for contributors, covering code style, PR process, and contribution workflows.
/frontend/README.md
)
Complete guide for setting up and developing the React-based frontend application./openhands/README.md
)
Detailed documentation of the Python backend implementation and architecture.
/openhands/server/README.md
)
Server implementation details, API documentation, and service architecture.
/openhands/runtime/README.md
)
Documentation covering the runtime environment, execution model, and runtime configurations.
/containers/README.md
)
Comprehensive information about Docker containers, deployment strategies, and container management./tests/unit/README.md
)
Instructions for writing, running, and maintaining unit tests.
/evaluation/README.md
)
Documentation for the evaluation framework, benchmarks, and performance testing.
/microagents/README.md
)
Detailed information about the microagents architecture, implementation, and usage./docs/DOC_STYLE_GUIDE.md
)
Standards and guidelines for writing and maintaining project documentation.README.md
to understand the project’s purpose and featuresCONTRIBUTING.md
guidelines if you plan to contributeDevelopment.md
/frontend/README.md
/openhands/README.md
/containers/README.md
/docs/DOC_STYLE_GUIDE.md