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

Add SDK documentation for local conversation part of "sdk/guides".

Will need to merge OpenHands/software-agent-sdk#859 first to update SDK examples before merging this PR.

xingyaoww and others added 3 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>
@xingyaoww xingyaoww marked this pull request as ready for review October 21, 2025 21:55
@xingyaoww xingyaoww marked this pull request as draft October 21, 2025 21:55
@xingyaoww xingyaoww marked this pull request as ready for review October 21, 2025 22:58
@xingyaoww xingyaoww changed the title SDK Docs SDK Docs for local "guides" Oct 21, 2025
@xingyaoww xingyaoww requested a review from neubig October 21, 2025 22:59
@neubig
Copy link
Contributor

neubig commented Oct 22, 2025

@OpenHands Do a code review of this PR.

@openhands-ai
Copy link

openhands-ai bot commented Oct 22, 2025

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

@openhands-ai
Copy link

openhands-ai bot commented Oct 22, 2025

I've completed a comprehensive code review of PR #41 "SDK Docs for local 'guides'" in the OpenHands/docs repository.

Review Summary

This PR adds 20 new SDK documentation files covering conversation features, LLM features, agent features, and security. I analyzed all files for:

  • Documentation structure and formatting
  • Code block syntax compliance with SDK guidelines
  • GitHub link accuracy and consistency
  • Navigation configuration in docs.json
  • Grammar, typos, and style issues
  • Internal link integrity

Findings

🟢 Minor Issues (2 total)

  1. Grammar error in security.mdx (line 10)

    • "Confirmation policy control" should be "Confirmation policies control" (subject-verb agreement)
  2. Capitalization inconsistency in mcp.mdx (lines 106, 219)

    • Two bash blocks use "Running the example" instead of "Running the Example"

✅ What's Working Well

  • All 20 files have proper frontmatter with titles and descriptions
  • Code block syntax correctly uses icon="python" and expandable attributes
  • All synced code blocks have corresponding Note components with GitHub links
  • Navigation structure properly organized with logical groupings
  • All files correctly listed in docs.json
  • No broken internal links detected
  • No typos found
  • Consistent GitHub repository references
  • OpenAPI updates appear legitimate

Conclusion

This is a high-quality documentation PR that follows the established SDK documentation guidelines. The only issues found are very minor formatting/grammar items that don't affect functionality. The documentation is comprehensive, well-structured, and ready for use once the dependent agent-sdk PR #859 is merged (as noted in the PR description).

No changes were made to the code as this was a review-only request. The minor issues identified above can be addressed by the PR author if desired, but they are not blocking.

View full conversation

Synced from agent-sdk ref: main
{
"group": "API Reference",
"openapi": {
"source": "/openapi/agent-sdk.json"
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@enyst here's where we will add the API reference for the SDK - this feels more in-place to sit near the description of agent-server

@xingyaoww xingyaoww merged commit b419a23 into main Oct 22, 2025
2 checks passed
enyst added a commit that referenced this pull request Nov 8, 2025
Co-authored-by: openhands <openhands@all-hands.dev>
Co-authored-by: Engel Nyst <enyst@users.noreply.github.com>
Co-authored-by: enyst <engel.nyst@gmail.com>
Co-authored-by: Calvin Smith <calvin@all-hands.dev>
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.

6 participants