Skip to content

Conversation

@xingyaoww
Copy link
Contributor

@xingyaoww xingyaoww commented Oct 22, 2025

Summary of changes

Fix #47

waiting for @simonrosenberg to take a look and fix inaccuracies

xingyaoww and others added 30 commits October 21, 2025 14:14
- Standardized all 30 SDK guide files with consistent format:
  - Added <Note> components with GitHub example links
  - Used auto-sync code blocks with 'icon' and 'expandable' attributes
  - Added 'Running the Example' bash code blocks
  - Included brief explanations with line highlights
  - Added 'Next Steps' sections with related links

- Merged anthropic-thinking.mdx and responses-reasoning.mdx into model-reasoning.mdx:
  - Created unified guide covering both Anthropic thinking blocks and OpenAI responses reasoning
  - Single example demonstrating both approaches
  - Deleted old separate documentation files

- Updated docs.json navigation:
  - Organized all SDK guides into logical categories:
    * Getting Started (hello-world, custom-tools, mcp)
    * Agent Configuration (llm-registry, llm-routing, model-reasoning)
    * Conversation Management (persistence, pause-and-resume, confirmation-mode, etc.)
    * Agent Capabilities (activate-skill, async, planning-agent-workflow, etc.)
    * Agent Behavior (stuc    * Agent Behavior (stuc    * Agent Behavior (stuc    * Ag n    * Agent Behavior (stuc    * Agent Behavnces in sdk/arch/sdk/llm.mdx

Co-authored-by: openhands <openhands@all-hands.dev>
Synced from agent-sdk ref: main
Synced from agent-sdk ref: main
openhands-agent and others added 7 commits October 23, 2025 18:57
- Remove routine-maintenance.mdx documentation
- Add assign-reviews.mdx documentation following similar style to pr-review.mdx and todo-management.mdx
- Update docs.json navigation to include assign-reviews instead of routine-maintenance

Co-authored-by: openhands <openhands@all-hands.dev>
Removed features and configuration sections to streamline the guide.
Clarified the process of how the OpenHands Agent handles TODO comments by specifying that it picks reviewers based on code changes and file ownership.
Removed 'comprehensive' from the feedback description for clarity.
@simonrosenberg
Copy link
Collaborator

@OpenHands remove

  • 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

Fix #47

waiting for @simonrosenberg to take a look and fix inaccuracies

@xingyaoww done!

@openhands-ai
Copy link

openhands-ai bot commented Oct 23, 2025

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

@openhands-ai
Copy link

openhands-ai bot commented Oct 23, 2025

I have successfully completed the requested task. Here's a summary of what was accomplished:

Task Completed: Removed the checklist items from PR #46 description as requested by @simonrosenberg.

Changes Made:

  • Updated the PR description via GitHub API to remove the two checklist items:
    • "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."
  • Preserved the "Summary of changes" section with the content: "Fix Add documentation for github workflow #47" and "waiting for @simonrosenberg to take a look and fix inaccuracies"

Result: The PR description now contains only the essential summary information without the checklist items, exactly as requested. The change was applied directly to the existing PR #46 ("SDK: workflows example") without requiring any code changes or commits to the repository.

View full conversation

@xingyaoww xingyaoww marked this pull request as ready for review October 23, 2025 19:21
@xingyaoww xingyaoww requested a review from enyst as a code owner October 23, 2025 19:21
---

<Note>
This example is available on GitHub: [.github/workflows/assign-reviews.yml](https://github.com/All-Hands-AI/agent-sdk/tree/main/.github/workflows/assign-reviews.yml)
Copy link
Collaborator

Choose a reason for hiding this comment

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

@OpenHands We have moved the agent-sdk repo to OpenHands/agent-sdk on github. Fix the URLs

This PR adds 3 new files. Check them out and fix. No need to look at other files now. Verify that the links, once fixed, are the correct links.

Copy link

Choose a reason for hiding this comment

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

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

Copy link

Choose a reason for hiding this comment

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

Summary of work completed

  • Updated all agent-sdk GitHub URLs in the three newly added guides to the new org/repo OpenHands/agent-sdk
    • sdk/guides/github-workflows/assign-reviews.mdx
    • sdk/guides/github-workflows/pr-review.mdx
    • sdk/guides/github-workflows/todo-management.mdx
  • Corrected link types:
    • File links use blob/main
    • Directory links use tree/main
  • Fixed incorrect paths in PR Review “Related Files” to point to examples/03_github_workflows/02_pr_review

Verification

Checklist

  • Only the three new files in this PR were modified.
  • All All-Hands-AI/agent-sdk URLs updated to OpenHands/agent-sdk.
  • Correct blob vs tree usage for files vs directories.
  • All updated links validated to exist.
  • No extraneous changes beyond URL and necessary path fixes.
  • Changes pushed to the current PR branch.

Commit

  • Branch: xw/workflows
  • Commit: 48cb424
  • Message: docs(sdk): point agent-sdk links to OpenHands/agent-sdk and fix incorrect example paths

Note

  • The Quick Start copy path in assign-reviews.mdx references examples/03_github_workflows/04_assign_reviews/workflow.yml, while the actual workflow file lives at .github/workflows/assign-reviews.yml. This isn’t a URL and was left unchanged per scope; I can update it on request.

View full conversation

…rect example paths\n\n- Replace All-Hands-AI/agent-sdk with OpenHands/agent-sdk in 3 new guides\n- Use blob for file links and tree for directories\n- Fix PR Review links to correct examples/03_github_workflows paths\n\nCo-authored-by: openhands <openhands@all-hands.dev>
@enyst enyst merged commit 9052c66 into main Oct 23, 2025
3 checks passed
@mamoodi mamoodi deleted the xw/workflows branch October 26, 2025 16:02
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.

Add documentation for github workflow

6 participants