Skip to content

Conversation

@xingyaoww
Copy link
Contributor

@xingyaoww xingyaoww commented Oct 21, 2025

  • I have read and reviewed the documentation changes to the best of my ability.
  • If the change is significant, I have run the documentation site locally and confirmed it renders as expected.

Summary of changes
Update repo md

openhands-agent and others added 3 commits October 21, 2025 15:16
- Added detailed explanation of all 4 microagent types (general, keyword-triggered, org/user, global)
- Included frontmatter format examples and best practices
- Added repository structure visualization
- Documented microagent-specific workflows and contributor guidelines
- Preserved all existing documentation system content
- Added CI/CD workflow information

The repo.md microagent now serves as both a guide to the repository and a comprehensive reference for creating and using microagents.
Synced from agent-sdk ref: main
The repo.md file itself is the microagent, so listing 'Microagents Documentation' as a separate purpose is redundant.
@xingyaoww xingyaoww changed the title Add comprehensive microagent documentation to repo.md Update repo.md Oct 21, 2025
@xingyaoww xingyaoww marked this pull request as ready for review October 21, 2025 15:31
@xingyaoww xingyaoww enabled auto-merge (squash) October 21, 2025 15:31
@xingyaoww xingyaoww requested a review from enyst October 21, 2025 15:31
Co-authored-by: Engel Nyst <enyst@users.noreply.github.com>

## 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

- **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

@xingyaoww xingyaoww merged commit b795ab4 into main Oct 21, 2025
2 checks passed
@enyst
Copy link
Collaborator

enyst commented Oct 21, 2025

@OpenHands Read all review threads in this PR. If there are still suggestions that were not included in the PR that was merged on main, please extract them and open a new PR with them.

It's because the PR was set on auto-merge, so it went in as soon as approved.

@openhands-ai
Copy link

openhands-ai bot commented Oct 21, 2025

I'm on it! enyst can track my progress at all-hands.dev

@openhands-ai
Copy link

openhands-ai bot commented Oct 21, 2025

Summary of work completed

What you asked

  • Read all review threads on PR Update repo.md #37
  • If any approved suggestions weren’t included in the merged commit on main, extract them and open a new PR with those changes

What I did

  • Retrieved PR Update repo.md #37 context and review threads via GitHub API and extracted 7 suggestion comments
  • Compared the merged file on main against those suggestions
  • Created a new branch from main, applied the missing suggestions to .openhands/microagents/repo.md, and opened a PR

Changes made (concise)

  • Repository Purpose: “OpenHands Docs” now reads “client applications”
  • Added “Working with Microagent Documentation” section with guidance and links to key files
  • Renamed “Notes for Contributors” to “Notes”
  • Expanded Notes with reviewer-proposed items:
    • Microagents consume context window; keep concise
    • Test keyword triggers
    • Ensure agent-sdk example paths are correct
    • Update both code and docs when adding new microagent types
    • Reminder that repo.md is itself a microagent example

Git details (double-checked)

Checklist

  • Read all review threads: done
  • Identified suggestions not merged on main: done
  • Implemented missing suggestions: done (no extraneous changes)
  • Opened a new PR against main: done
  • No comments left on the PR: confirmed

Notes

  • One early suggestion proposed a large “Microagents in This Repository” block. It overlaps with existing pages under openhands/usage/microagents/. To avoid duplication, I didn’t include that block. If you prefer that content duplicated in repo.md as well, I can add it to PR Apply missed review suggestions to repo microagent doc #39.

View full conversation

@mamoodi mamoodi deleted the add-microagent-documentation branch October 22, 2025 14:51
enyst pushed a commit that referenced this pull request Nov 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants