Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 58 additions & 4 deletions .openhands/microagents/repo.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,43 @@
# Documentation System Overview
# OpenHands Documentation Repository

The documentation for this project follows a synchronized approach where code examples in the docs are automatically kept in sync with the actual example files in the agent-sdk repository.
This repository contains the official documentation for OpenHands, including guides for the Agent SDK and the client OpenHands applications. The documentation is deployed using Mintlify and features an automated code synchronization system.

## Repository Purpose

- **OpenHands Docs**: User guides, tutorials, and reference documentation for OpenHands core application
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- **OpenHands Docs**: User guides, tutorials, and reference documentation for OpenHands core application
- **OpenHands Docs**: User guides, tutorials, and reference documentation for OpenHands client applications

Because of CLI app it's plural, strictly speaking

- **Agent SDK Docs**: Developer documentation for the OpenHands Agent SDK

## Repository Structure

```
docs/
├── .openhands/microagents/ # Repository microagents (like this file)
├── .github/
│ ├── scripts/
│ │ └── sync_code_blocks.py # Code synchronization script
│ └── workflows/ # CI/CD workflows
├── openhands/ # OpenHands core documentation
│ └── usage/
│ ├── microagents/ # Microagent documentation
│ ├── cloud/ # Cloud service docs
│ ├── settings/ # Settings documentation
│ └── ...
├── sdk/ # Agent SDK documentation
│ ├── guides/ # SDK tutorials and guides
│ └── arch/ # Architecture documentation
└── docs.json # Mintlify navigation configuration
```

### Key Files

- **`docs.json`**: Mintlify configuration including navigation structure, theme, and redirects
- **Microagent docs**: `openhands/usage/microagents/microagents-*.mdx`
- **Sync script**: `.github/scripts/sync_code_blocks.py`
- **This microagent**: `.openhands/microagents/repo.md`

## Documentation System Overview

The documentation follows a synchronized approach where code examples are automatically kept in sync with actual example files in the agent-sdk repository.

## Automatic Code Synchronization

Expand Down Expand Up @@ -213,6 +249,24 @@ name: Example Workflow
on: [push]
```

## Mintlify documentation
## Mintlify Documentation

You can check https://www.mintlify.com/docs for documentation on what our doc site supports.

## CI/CD Workflows

### Code Synchronization Workflow
- **File**: `.github/workflows/sync-docs-code-blocks.yml`
- **Triggers**: Push to any branch, daily at 2 AM UTC, manual dispatch
- **Purpose**: Keeps code blocks in sync with agent-sdk examples
- **Actions**: Checks out both repositories, runs sync script, commits changes if needed

### OpenAPI Sync Workflow
- **File**: `.github/workflows/sync-agent-sdk-openapi.yml`
- **Purpose**: Syncs OpenAPI specifications for API documentation

## Notes for Contributors
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Notes for Contributors
## Notes


You can check https://www.mintlify.com/docs for documentation on what our doc site supported.
- For agent-sdk examples, ensure the file path in code blocks is correct
- For short agent-sdk examples, you don't need `expandable` in example file
- When you add new pages that need to refer to agent-sdk example script, you should create an empty block with correct block name (refer to the python example script correctly), then run `python .github/scripts/sync_code_blocks.py` to sync it
2 changes: 1 addition & 1 deletion agent-sdk
Submodule agent-sdk updated from 74cc24 to 8d8134
Loading