Skip to content

Commit a57cdb1

Browse files
merge: main into remove-git-submodules; resolve conflict by keeping agent-sdk removal and accepting upstream doc changes
- Keep deletion of agent-sdk (submodule/content) to align with PR purpose - Accept updates from main to .openhands/microagents/repo.md Co-authored-by: openhands <openhands@all-hands.dev>
2 parents 8d56920 + b795ab4 commit a57cdb1

File tree

1 file changed

+58
-4
lines changed

1 file changed

+58
-4
lines changed

.openhands/microagents/repo.md

Lines changed: 58 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,43 @@
1-
# Documentation System Overview
1+
# OpenHands Documentation Repository
22

3-
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.
3+
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.
44

5+
## Repository Purpose
6+
7+
- **OpenHands Docs**: User guides, tutorials, and reference documentation for OpenHands core application
8+
- **Agent SDK Docs**: Developer documentation for the OpenHands Agent SDK
9+
10+
## Repository Structure
11+
12+
```
13+
docs/
14+
├── .openhands/microagents/ # Repository microagents (like this file)
15+
├── .github/
16+
│ ├── scripts/
17+
│ │ └── sync_code_blocks.py # Code synchronization script
18+
│ └── workflows/ # CI/CD workflows
19+
├── openhands/ # OpenHands core documentation
20+
│ └── usage/
21+
│ ├── microagents/ # Microagent documentation
22+
│ ├── cloud/ # Cloud service docs
23+
│ ├── settings/ # Settings documentation
24+
│ └── ...
25+
├── sdk/ # Agent SDK documentation
26+
│ ├── guides/ # SDK tutorials and guides
27+
│ └── arch/ # Architecture documentation
28+
└── docs.json # Mintlify navigation configuration
29+
```
30+
31+
### Key Files
32+
33+
- **`docs.json`**: Mintlify configuration including navigation structure, theme, and redirects
34+
- **Microagent docs**: `openhands/usage/microagents/microagents-*.mdx`
35+
- **Sync script**: `.github/scripts/sync_code_blocks.py`
36+
- **This microagent**: `.openhands/microagents/repo.md`
37+
38+
## Documentation System Overview
39+
40+
The documentation follows a synchronized approach where code examples are automatically kept in sync with actual example files in the agent-sdk repository.
541

642
## Automatic Code Synchronization
743

@@ -213,6 +249,24 @@ name: Example Workflow
213249
on: [push]
214250
```
215251
216-
## Mintlify documentation
252+
## Mintlify Documentation
253+
254+
You can check https://www.mintlify.com/docs for documentation on what our doc site supports.
255+
256+
## CI/CD Workflows
257+
258+
### Code Synchronization Workflow
259+
- **File**: `.github/workflows/sync-docs-code-blocks.yml`
260+
- **Triggers**: Push to any branch, daily at 2 AM UTC, manual dispatch
261+
- **Purpose**: Keeps code blocks in sync with agent-sdk examples
262+
- **Actions**: Checks out both repositories, runs sync script, commits changes if needed
263+
264+
### OpenAPI Sync Workflow
265+
- **File**: `.github/workflows/sync-agent-sdk-openapi.yml`
266+
- **Purpose**: Syncs OpenAPI specifications for API documentation
267+
268+
## Notes for Contributors
217269

218-
You can check https://www.mintlify.com/docs for documentation on what our doc site supported.
270+
- For agent-sdk examples, ensure the file path in code blocks is correct
271+
- For short agent-sdk examples, you don't need `expandable` in example file
272+
- 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

0 commit comments

Comments
 (0)