Skip to content

docs: add model choice guides#508

Merged
neubig merged 7 commits into
mainfrom
openhands/model-choice-docs
May 17, 2026
Merged

docs: add model choice guides#508
neubig merged 7 commits into
mainfrom
openhands/model-choice-docs

Conversation

@neubig
Copy link
Copy Markdown
Contributor

@neubig neubig commented May 15, 2026

  • 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

Closes #507.

  • Fold the /model slash command guidance into the main Language Model (LLM) Settings page, including one Agent Canvas screenshot for manual switching.
  • Fold the model selection tool guidance into the same page, including one Agent Canvas screenshot and notes for SwitchLLMTool / switch_llm behavior.
  • Remove the standalone model choice pages and dedicated sidebar group.

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

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

mintlify Bot commented May 15, 2026

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

Project Status Preview Updated (UTC)
all-hands-ai 🟢 Ready View Preview May 15, 2026, 1:04 PM

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

Co-authored-by: openhands <openhands@all-hands.dev>
Co-authored-by: openhands <openhands@all-hands.dev>
Co-authored-by: openhands <openhands@all-hands.dev>
Co-authored-by: openhands <openhands@all-hands.dev>
Co-authored-by: openhands <openhands@all-hands.dev>
@neubig neubig marked this pull request as ready for review May 15, 2026 20:47
@neubig neubig requested a review from mamoodi as a code owner May 15, 2026 20:47
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 - Well-structured documentation that follows style guidelines, includes clear workflows with appropriate screenshots, and provides proper cross-references. The example profiles are clearly marked as examples, and all technical content is accurate.

[RISK ASSESSMENT]

  • [Overall PR] ⚠️ Risk Assessment: 🟢 LOW
    Documentation-only change with no code modifications. Adds two new guides with screenshots and updates navigation. All internal links verified, screenshots match documented workflows, and content follows repository style guidelines.

VERDICT:
Worth merging: Clear, well-organized documentation that properly explains model switching features.

KEY INSIGHT:
The documentation successfully balances practical examples (using concrete profile names in screenshots) with generality (clearly stating profile names are examples only), making it both illustrative and flexible for different deployment scenarios.

@neubig
Copy link
Copy Markdown
Contributor Author

neubig commented May 16, 2026

@OpenHands let's remove the two de-novo pages (and the sidebar) and just include the info that we have in the main LLM settings page. But include one screenshot for the /model command and one screenshot for the model selection tool.

@openhands-ai
Copy link
Copy Markdown

openhands-ai Bot commented May 16, 2026

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

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

neubig commented May 16, 2026

Addressed in f9e8212: removed the two standalone model choice pages and sidebar group, then consolidated the /model command and model selection tool guidance into the main Language Model (LLM) Settings page with one screenshot for each workflow.

Validation: npx --yes mint@latest broken-links passed.

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

@openhands-ai
Copy link
Copy Markdown

openhands-ai Bot commented May 16, 2026

Since my last summary, there were no additional code or documentation changes.

Checklist:

  • ✅ The PR comment request was fully addressed: the two standalone model choice pages and sidebar group were removed.
  • ✅ The relevant /model command and model selection tool information was consolidated into the main LLM settings page.
  • ✅ One screenshot remains for the /model command workflow and one for the model selection tool workflow.
  • ✅ The extra screenshot and stale references were removed.
  • ✅ The changes are concise and limited to the requested scope.
  • ✅ Validation passed with npx --yes mint@latest broken-links.
  • ✅ The commit was pushed to the existing PR branch, and PR docs: add model choice guides #508 was updated with a revised body and response comment.

No extraneous changes remain.

@neubig neubig merged commit e71d383 into main May 17, 2026
5 checks passed
@neubig neubig deleted the openhands/model-choice-docs branch May 17, 2026 19:25
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.

Create documentation for model choice options

3 participants