OpenHands / OpenHands/docs

Add Integrations Directory (like Hugging Face's)

Open
#551 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation enhancement integrations
Dominant language
MDX
Stars
12
Forks
52
Avg merge
1d 6h
Merged PRs (30d)
32

Description

Summary

We should add an "Integrations" page to the OpenHands documentation (similar to Hugging Face's Add Your Integration page) to encourage and guide third-party integrators to document their OpenHands integrations.

Motivation

Just as Hugging Face's integration directory has helped build an ecosystem of tools working with their Inference Providers, an OpenHands integrations page would:

  1. Lower barriers to entry - Make it easy for tool maintainers to get their integrations documented
  2. Build ecosystem awareness - Users would discover tools that work with OpenHands in one place
  3. Encourage contributions - Clear guidelines make it more likely people will add documentation
  4. Attract partnerships - A formal integration program signals openness to collaboration

Proposed Structure

Based on the Hugging Face model, an OpenHands integrations page could include:

Requirements

To be listed, an integration should:

  • Work with OpenHands (SDK, Cloud, or self-hosted)
  • Be actively maintained with recent commits or releases
  • Have clear documentation showing how to connect to OpenHands
How to Submit
  1. Test your integration with OpenHands
  2. Fork the openhands/docs repository
  3. Update an index file (e.g., overview/integrations/index.mdx) to add your tool to a table with a link to your integration docs
  4. Submit a Pull Request with your changes
  5. (Optional) Create a dedicated integration page (e.g., overview/integrations/your-tool-name.mdx)
Integration Page Template
---
title: Your Tool Name
description: Brief description of what your tool does with OpenHands
---

# Your Tool Name

Brief description of what your tool does.

## Overview
How your tool integrates with OpenHands.

## Prerequisites
- Your tool installed
- OpenHands account (if using Cloud API)

## Configuration
Step-by-step setup instructions with code examples.

## Resources
- [Your Tool Documentation](https://yourtool.com/docs)
- [OpenHands Integration Guide](/your-guide)

Example Integrations to Feature

Potential first-party integration documentation we could add:

  • GitHub Actions - Running OpenHands in CI/CD
  • Slack/Mattermost bots - Chat-based agent interactions
  • Cursor/Windsurf/Roo Code extensions - IDE integrations
  • MCP (Model Context Protocol) clients/servers
  • CI/CD platforms (Jenkins, GitLab CI, CircleCI, etc.)

Next Steps

  1. Create overview/integrations/index.mdx as the integrations directory index
  2. Add navigation entry in docs.json
  3. Create template and guidelines
  4. Seed with existing known integrations

Reference: Hugging Face's Add Your Integration page that inspired this proposal.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the documentation structure and navigation in docs.json, then inspect the proposed overview/integrations/index.mdx location. Define the integrations directory, submission guidance, template, and navigation entry described in the issue. Done means the index, guidelines, template, navigation entry, and initial known integrations are documented.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.