Developer Documentation with Live Repository Context
A platform team maintains API documentation in Confluence for internal consumers. The documentation references specific GitHub repositories, code files, and README content. When developers read the docs, they need to see the current state of the code, not a stale copy.
The challenge: The platform team pastes code snippets from GitHub into Confluence pages. These snippets become outdated the moment the code changes. Developers follow outdated examples from the documentation and submit pull requests that do not compile. The platform team spends time answering questions that would be resolved if the documentation reflected the current code.
How GitHub Links for Confluence helps:
- Live code embeds: Paste a GitHub file URL into Confluence and the actual source code renders inline with syntax highlighting. When the file changes in GitHub, the Confluence page automatically shows the updated code.
- README rendering: Embed a repository's README directly in a Confluence page. When the README is updated in GitHub, the Confluence documentation reflects the change without manual editing.
- Repository overview cards: Paste a repository URL to show a summary card with the repo description, language, stars, and last update date. Readers quickly assess the repo without leaving Confluence.
The result: Documentation stays current automatically. Developers trust the Confluence pages because the code examples always match the actual repository. Support requests to the platform team decrease because the documentation is accurate.
Architecture Decision Records with PR References
An engineering team documents architecture decisions in Confluence ADR pages. Each ADR references the pull requests that implement the decision. Readers need to see the PR status to understand whether the decision has been fully implemented.
The challenge: ADR pages include plain URLs to GitHub PRs. Over time, readers cannot tell which PRs were merged, which were abandoned, and which are still open. The ADR reads as if the decision was implemented, but some PRs may have been closed without merging.
How GitHub Links for Confluence helps:
- PR status cards: Paste a GitHub PR URL and it renders as a card showing the title, status (open, merged, closed), reviewer approvals, and CI check results. Readers see at a glance whether the implementation is complete.
- Multiple PR tracking: For decisions that span multiple PRs, each one renders as its own card on the ADR page. The team sees the full implementation status without clicking through to GitHub.
- Gist embeds for code samples: When the ADR includes code examples or configuration samples, embed GitHub Gists that render with syntax highlighting and stay up to date.
The result: ADR pages are living documents that show the real implementation status. New team members reading historical ADRs can distinguish between fully implemented decisions and partially completed ones.
Open Source Project Documentation Hub
A company maintains several open source libraries on GitHub. The internal Confluence wiki serves as the coordination hub where the team plans releases, tracks contributions, and documents internal processes. External contributors use the GitHub README and wiki.
The challenge: The internal team needs to see GitHub activity without constantly switching to GitHub. They want to track issue counts, PR backlog, and release status from Confluence. Manually updating these numbers in Confluence is tedious and always outdated.
How GitHub Links for Confluence helps:
- Issue and PR previews: Embed links to key GitHub issues and PRs on the Confluence project page. The team sees issue status, comments count, and assignees directly in their planning hub.
- Release tracking: Paste links to GitHub releases on the Confluence roadmap page. Each release renders with its tag name, title, and publication date.
- Contributor-friendly docs: The team maintains internal process docs in Confluence that reference the same GitHub repos external contributors use. Live links ensure the internal docs always point to the correct repository structure.
The result: The internal team manages open source projects from Confluence with real-time GitHub context. Planning meetings reference live data instead of stale screenshots. The team catches backlog growth early because issue counts are always visible.
Engineering QBR and team-health pages with live delivery metrics
An engineering manager runs sprint reviews and quarterly business reviews from Confluence. They want a quick, honest read on delivery health - without exporting data or standing up a separate analytics platform.
The challenge: Delivery metrics usually live in a tool nobody opens during the meeting, so reviews rely on stale screenshots or gut feel.
How GitHub Links for Confluence helps:
- PR Cycle Time, Throughput, and Review Latency macros render team-level delivery metrics live on the page, computed from the GitHub API at view time.
- Nothing stored: we store no code or PR data, and reporting reuses your existing GitHub connection.
The result: QBR and team-health pages show current, team-level delivery signals where the conversation already happens - included in the app, with no separate platform.