Skip to content

docs: document SDK switch LLM example#499

Open
neubig wants to merge 1 commit intomainfrom
agent-switch-llm-tool
Open

docs: document SDK switch LLM example#499
neubig wants to merge 1 commit intomainfrom
agent-switch-llm-tool

Conversation

@neubig
Copy link
Copy Markdown
Contributor

@neubig neubig commented May 10, 2026

Summary

  • Document the new switch_llm SDK example in the LLM Profile Store guide.
  • Add docs references for the settings/secrets and workspace.get_llm() remote agent-server examples so the SDK documented-example check passes.

Validation

  • DOCS_PATH=/workspace/project/openhands-docs python /workspace/project/software-agent-sdk/.github/scripts/check_documented_examples.py

This pull request was created by an AI agent (OpenHands) on behalf of the user.

Co-authored-by: openhands <openhands@all-hands.dev>
@neubig neubig requested review from enyst and xingyaoww as code owners May 10, 2026 15:56
@mintlify
Copy link
Copy Markdown

mintlify Bot commented May 10, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
all-hands-ai 🟢 Ready View Preview May 10, 2026, 3:57 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

Copy link
Copy Markdown
Contributor

@all-hands-bot all-hands-bot left a comment

Choose a reason for hiding this comment

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

🟢 Good taste - Clean documentation addition that follows existing patterns.

The PR successfully documents three new SDK examples (49_switch_llm_tool.py, 12_settings_and_secrets_api.py, 13_workspace_get_llm.py) to satisfy the documented-example check. The additions:

  • Follow the established documentation structure and component usage
  • Provide clear, concise descriptions of the new features
  • Include proper GitHub source links and <RunExampleCode> components
  • Match the formatting and style of existing guide sections

[RISK ASSESSMENT]

  • [Overall PR] ⚠️ Risk Assessment: 🟢 LOW

Documentation-only change with no code modifications. The PR description confirms validation passes (check_documented_examples.py), and the changes are purely additive with no breaking changes or functional impact.

VERDICT:
Worth merging: Clean documentation update with no issues found.

KEY INSIGHT:
Straightforward documentation maintenance that properly integrates new SDK examples into the existing guide structure.

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