Skip to content

docs: add Enterprise GitHub integration guide - #760

Open
rajshah4 wants to merge 2 commits into
mainfrom
docs/enterprise-github-integration
Open

docs: add Enterprise GitHub integration guide#760
rajshah4 wants to merge 2 commits into
mainfrom
docs/enterprise-github-integration

Conversation

@rajshah4

@rajshah4 rajshah4 commented Aug 25, 2026

Copy link
Copy Markdown
Member

Summary

  • add a dedicated Enterprise GitHub integration guide
  • document GitHub App creation, installation, permissions, Admin Console configuration, and resolver prerequisites
  • explain bot versus user identity for acknowledgements, reviews, and completion comments
  • explain how resolver conversations load the baseline GitHub skill alongside repository, organization, and task-specific skills
  • distinguish agent behavior that skills can guide from integration-owned behavior, using pull request reviews as one example
  • add troubleshooting for OAuth layout mismatches, duplicate GitHub App installations, ignored mentions, review identity, and completion comments
  • add the guide to Enterprise navigation and link it from the Quick Start

Source Verification

Documentation claim Source
The helper configures the DNS-aware OAuth callback, webhook URL, permissions, and subscribed events create_github_app.py
Resolver triggers include the openhands issue label, issue comments, PR comments, and inline review comments github_view.py
The triggering user must have write access and a linked OpenHands account github_manager.py
Resolver conversations load public, project, and organization skills app_conversation_service_base.py
The GitHub resolver prompt mentions GitHub APIs, the public GitHub skill has a github trigger, and SDK trigger matching runs against the rendered user message pr_update_initial_message.j2, skills/github/SKILL.md, agent_context.py
Resolver reactions and status comments use the GitHub App installation token github_manager.py
The conversation receives the triggering user's GitHub provider token github_manager.py
Resolver views request a final summary for every supported trigger github_view.py
The callback processor posts that final response back to GitHub github_v1_callback_processor.py

Validation

  • git diff --cached --check — passed
  • python3 -m json.tool docs.json — passed
  • npx --yes --package=node@22 --package=mintlify@latest -c 'mint broken-links' — passed, no broken links
  • uv run --with pytest --with requests --with pyyaml pytest -q tests/ — 35 passed; two existing pricing tests errored because their upstream raw GitHub URL returns HTTP 404

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

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

mintlify Bot commented Aug 25, 2026

Copy link
Copy Markdown

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

Project Status Preview Updated (UTC)
all-hands-ai 🟢 Ready View Preview Aug 25, 2026, 4:35 PM

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

Co-authored-by: openhands <openhands@all-hands.dev>
@rajshah4
rajshah4 marked this pull request as ready for review August 25, 2026 16:57
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.

1 participant