Skip to content

Commit 23a9894

Browse files
Apply missed review suggestions to repo microagent doc
- Clarify scope: client applications wording - Add 'Working with Microagent Documentation' section - Rename 'Notes for Contributors' to 'Notes' - Expand Notes per review feedback Co-authored-by: openhands <[email protected]>
1 parent 15d07cf commit 23a9894

File tree

1 file changed

+24
-4
lines changed

1 file changed

+24
-4
lines changed

.openhands/microagents/repo.md

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This repository contains the official documentation for OpenHands, including gui
44

55
## Repository Purpose
66

7-
- **OpenHands Docs**: User guides, tutorials, and reference documentation for OpenHands core application
7+
- **OpenHands Docs**: User guides, tutorials, and reference documentation for OpenHands client applications
88
- **Agent SDK Docs**: Developer documentation for the OpenHands Agent SDK
99

1010
## Repository Structure
@@ -140,6 +140,24 @@ This example is available on GitHub: [examples/01_standalone_sdk/02_custom_tools
140140
</Note>
141141
```
142142

143+
## Working with Microagent Documentation
144+
145+
When modifying microagent-related documentation files:
146+
147+
1. Location: Microagent documentation is in `openhands/usage/microagents/`
148+
2. Navigation: Update `docs.json` if adding new pages to the microagents section
149+
3. Consistency: Follow the existing structure in microagent documentation files
150+
4. Cross-references: Link between related microagent pages using relative paths
151+
5. Examples: Include practical examples with proper code blocks (non-synced)
152+
153+
### Key Microagent Documentation Files
154+
155+
- `microagents-overview.mdx`: Introduction and types of microagents
156+
- `microagents-repo.mdx`: General microagents (always loaded)
157+
- `microagents-keyword.mdx`: Keyword-triggered microagents
158+
- `microagents-org.mdx`: Organization and user microagents
159+
- `microagents-public.mdx`: Global microagents (contributing guide)
160+
143161
## Writing New Documentation
144162

145163
### Step-by-Step Guide
@@ -265,8 +283,10 @@ You can check https://www.mintlify.com/docs for documentation on what our doc si
265283
- **File**: `.github/workflows/sync-agent-sdk-openapi.yml`
266284
- **Purpose**: Syncs OpenAPI specifications for API documentation
267285

268-
## Notes for Contributors
286+
## Notes
269287

288+
- Microagents take up context window space - keep them focused and concise
289+
- Test keyword triggers to ensure they activate appropriately
270290
- 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
291+
- When adding new microagent types, update both the code and documentation
292+
- Remember: this repo.md file is itself a microagent example!

0 commit comments

Comments
 (0)