Skip to content

Expand Jira integration docs with use case and examples#428

Merged
jpelletier1 merged 3 commits intomainfrom
openhands/expand-jira-docs
Apr 14, 2026
Merged

Expand Jira integration docs with use case and examples#428
jpelletier1 merged 3 commits intomainfrom
openhands/expand-jira-docs

Conversation

@jpelletier1
Copy link
Copy Markdown
Contributor

  • 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

This PR expands the Jira integration documentation to include a comprehensive overview section explaining the main use case for the integration.

Changes made:

  • Added Overview section explaining how OpenHands can automatically implement requirements from Jira tickets
  • Added How It Works subsection documenting the workflow:
    • How to specify the repository (in ticket body or comment)
    • How to trigger OpenHands (via openhands label or @openhands mention)
  • Added Example Ticket subsection with a complete example showing proper ticket structure including:
    • Clear title and user story
    • Repository specification
    • Acceptance criteria

Files modified:

  • openhands/usage/cloud/project-management/jira-integration.mdx (Jira Cloud)
  • openhands/usage/cloud/project-management/jira-dc-integration.mdx (Jira Data Center)

Both files now provide clear guidance to users on how to use the Jira integration for automated development workflows.

Fixes #427

@jpelletier1 can click here to continue refining the PR

- Added Overview section explaining the main use case
- Documented how to trigger OpenHands (label or @mention)
- Included example ticket structure with repository specification
- Applied to both Jira Cloud and Jira Data Center docs

Fixes #427

Co-authored-by: openhands <[email protected]>
@jpelletier1 jpelletier1 requested a review from mamoodi as a code owner April 1, 2026 14:45
@mintlify
Copy link
Copy Markdown

mintlify bot commented Apr 1, 2026

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

Project Status Preview Updated (UTC)
all-hands-ai 🟢 Ready View Preview Apr 1, 2026, 2:46 PM

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 addition of usage docs. Verified against source code. Found a few inaccuracies around repository provider naming and mention syntax that should be corrected.

Copy link
Copy Markdown

@tofarr tofarr left a comment

Choose a reason for hiding this comment

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

🍰 - This is exactly what is needed here!

@jpelletier1 jpelletier1 merged commit e45e7a0 into main Apr 14, 2026
5 checks passed
@jpelletier1 jpelletier1 deleted the openhands/expand-jira-docs branch April 14, 2026 19:15
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.

Expand Jira docs

4 participants