-
Notifications
You must be signed in to change notification settings - Fork 5
SDK Docs for local "guides" #41
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
Conversation
- 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
|
@OpenHands Do a code review of this PR. |
|
I'm on it! neubig can track my progress at all-hands.dev |
|
I've completed a comprehensive code review of PR #41 "SDK Docs for local 'guides'" in the OpenHands/docs repository. Review SummaryThis PR adds 20 new SDK documentation files covering conversation features, LLM features, agent features, and security. I analyzed all files for:
Findings🟢 Minor Issues (2 total)
✅ What's Working Well
ConclusionThis 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. |
Synced from agent-sdk ref: main
| { | ||
| "group": "API Reference", | ||
| "openapi": { | ||
| "source": "/openapi/agent-sdk.json" |
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.
@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
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>
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.