Skip to content

docs: add QA Changes use case and SDK guide#487

Draft
xingyaoww wants to merge 1 commit intomainfrom
docs/qa-changes-use-case
Draft

docs: add QA Changes use case and SDK guide#487
xingyaoww wants to merge 1 commit intomainfrom
docs/qa-changes-use-case

Conversation

@xingyaoww
Copy link
Copy Markdown
Contributor

Summary

Add documentation for the new QA Changes plugin — an automated QA validation workflow that goes beyond code review by actually running the code to verify PR changes work as described.

This is a companion to:

Changes

New Pages

Use Case: openhands/usage/use-cases/qa-changes.mdx

A comprehensive use case page (similar to the existing "Code Review" use case) covering:

  • Overview and how QA validation differs from code review
  • Four-phase methodology (Understand → Setup → Exercise → Report)
  • Quick Start with step-by-step setup instructions
  • Composite action inputs reference
  • QA report format and verdict values
  • Customization via skills and AGENTS.md
  • Security considerations (pull_request vs pull_request_target)
  • Optional QA evaluation workflow
  • Troubleshooting FAQ
  • Automation prompt template

SDK Guide: sdk/guides/github-workflows/qa-changes.mdx

An SDK-level guide (similar to the existing "PR Review" guide) covering:

  • Quick start and feature overview
  • Security model explanation
  • Custom skill examples for project-specific QA
  • Reference workflow YAML
  • Action inputs table
  • Links to related plugin files

Updated Pages

  • docs.json: Added navigation entries in both "Use Cases" tab and SDK "GitHub Workflows" group
  • openhands/usage/use-cases/overview.mdx: Added QA Changes card to the use cases overview

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

@xingyaoww can click here to continue refining the PR

Add documentation for the new QA Changes plugin that validates PR changes
by actually running the code — setting up the environment, exercising
changed behavior, and posting structured QA reports.

New pages:
- Use Case: openhands/usage/use-cases/qa-changes.mdx
- SDK Guide: sdk/guides/github-workflows/qa-changes.mdx

Updated pages:
- docs.json: Added navigation entries for both new pages
- overview.mdx: Added QA Changes card to use cases overview

Related: OpenHands/software-agent-sdk#2924
Related: OpenHands/extensions#135

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

mintlify Bot commented May 4, 2026

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

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

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

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.

2 participants