-
Notifications
You must be signed in to change notification settings - Fork 4
Update repo.md #37
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Update repo.md #37
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
5f906a3
Add comprehensive microagent documentation to repo.md
openhands-agent 725f91f
docs: sync code blocks from agent-sdk examples
github-actions[bot] 5a6ab96
Remove redundant Microagents Documentation from Repository Purpose
openhands-agent 0ac79fa
Apply suggestion from @xingyaoww
xingyaoww 24610d1
Apply suggestion from @xingyaoww
xingyaoww 7e529e0
Apply suggestion from @xingyaoww
xingyaoww 6a159a5
Apply suggestion from @xingyaoww
xingyaoww 9da54dd
Update .openhands/microagents/repo.md
xingyaoww File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 | ||||||
| - **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 | ||||||
|
|
||||||
|
|
@@ -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 | ||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
|
||||||
| 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 | ||||||
Submodule agent-sdk
updated
from 74cc24 to 8d8134
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Because of CLI app it's plural, strictly speaking