Skip to content

docs(sdk): add GPT-5 preset example page linking to code#202

Merged
enyst merged 3 commits intomainfrom
docs/gpt5-preset-example
Apr 4, 2026
Merged

docs(sdk): add GPT-5 preset example page linking to code#202
enyst merged 3 commits intomainfrom
docs/gpt5-preset-example

Conversation

@enyst
Copy link
Copy Markdown
Collaborator

@enyst enyst commented Dec 20, 2025

Summary

Add an SDK guide for the GPT-5 preset example. It documents get_gpt5_agent(llm), which creates an agent that opts into ApplyPatchTool-based editing instead of the default FileEditorTool.

What changed

  • Added sdk/guides/gpt5-preset.mdx
    • Links directly to the live example in software-agent-sdk
    • Includes an expandable code block synced to examples/04_llm_specific_tools/01_gpt5_apply_patch_preset.py
    • Uses the shared run-example snippet and calls out optional LLM_MODEL selection
    • Explains that the preset is explicit and opt-in, leaving the default preset unchanged
  • Added sdk/guides/gpt5-preset to the SDK sidebar under LLM Features

Verification

  • Cloned OpenHands/software-agent-sdk and verified the current example exists at examples/04_llm_specific_tools/01_gpt5_apply_patch_preset.py
  • Confirmed main in this docs repo does not already document this preset

This PR description was updated by an AI assistant (OpenHands) on behalf of the user.

- Mirrors Gemini preset style (opt-in, expandable snippet)
- Links to examples/01_standalone_sdk/35_gpt5_apply_patch_preset.py

Co-authored-by: openhands <openhands@all-hands.dev>
@enyst
Copy link
Copy Markdown
Collaborator Author

enyst commented Apr 4, 2026

@OpenHands This PR is a bit old and I forgot why it wasnt merged. Verify what it documents by cloning agent-sdk and finding it; then verify in docs here if we already document this preset. if yes, close this PR; if not, mark it ready for review after you explain in PR descrption what it does; babysit for some 4 mins for an AI reviewer bot to show up, read its feedback including inline threads, address it if you see fit; if approved, merge it.

@openhands-ai
Copy link
Copy Markdown

openhands-ai bot commented Apr 4, 2026

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

Co-authored-by: openhands <openhands@all-hands.dev>
@enyst enyst marked this pull request as ready for review April 4, 2026 20:56
@enyst enyst requested a review from xingyaoww as a code owner April 4, 2026 20:56
Copy link
Copy Markdown
Collaborator Author

enyst commented Apr 4, 2026

Verified this PR against the live software-agent-sdk example before updating it. The old referenced path was stale; the current example is examples/04_llm_specific_tools/01_gpt5_apply_patch_preset.py, and main in this docs repo does not already document this preset.

I updated the guide to point at the current example, added it to the SDK sidebar, refreshed the PR description to explain what the preset does, and marked the PR ready for review. I'll babysit for reviewer feedback and address anything reasonable that comes up.

This comment was created by an AI assistant (OpenHands) on behalf of the user.

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, accurate documentation that solves a real problem.

Verification: Cloned software-agent-sdk and confirmed the example file, get_gpt5_agent() function, and all imports exist and match exactly. The code is real, not hallucinated.

Style compliance: Follows the doc style guide (title case headers, absolute links, proper frontmatter, correct code sync format).

Navigation: Sensibly placed in "LLM Features" section.

This is pragmatic documentation work - documents an existing feature users need to know about, does it simply and accurately, breaks nothing. Worth merging.

This review was posted by an AI assistant (OpenHands) on behalf of the user.

@enyst enyst merged commit de07572 into main Apr 4, 2026
7 checks passed
@enyst enyst deleted the docs/gpt5-preset-example branch April 4, 2026 21:01
@openhands-ai
Copy link
Copy Markdown

openhands-ai bot commented Apr 4, 2026

Final summary:

  • Fully addressed the request.
  • Verified the PR against the live software-agent-sdk example.
  • Confirmed this preset was not already documented on main.
  • Updated the docs page to use the current example path and real synced example content.
  • Added the page to SDK navigation in docs.json.
  • Updated the PR description to clearly explain what the preset does.
  • Marked the PR ready for review.
  • Babysat the PR for about 4 minutes.
  • Checked reviewer feedback, including inline-thread status.
  • Merged the PR after approval and passing checks.

New outcome since the last summary:

PR: #202
Merge commit: de07572fe2fbcbe57f57ca82400c3a24b48e6ab2

xingyaoww pushed a commit that referenced this pull request Apr 5, 2026
…onvention

- Rename sdk/guides/gpt5-preset.mdx → sdk/guides/llm-gpt5-preset.mdx
- Update docs.json sidebar reference
- Add SDK guide file naming convention (llm-, agent-, convo- prefixes) to AGENTS.md
- Add naming convention check to code-review skill

Addresses review feedback on PR #202.

Co-authored-by: openhands <openhands@all-hands.dev>
xingyaoww added a commit that referenced this pull request Apr 5, 2026
…onvention (#434)

- Rename sdk/guides/gpt5-preset.mdx → sdk/guides/llm-gpt5-preset.mdx
- Update docs.json sidebar reference
- Add SDK guide file naming convention (llm-, agent-, convo- prefixes) to AGENTS.md
- Add naming convention check to code-review skill

Addresses review feedback on PR #202.

Co-authored-by: openhands <openhands@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.

3 participants