← Back

Link External Resources

← Back to all docs

Link External Resources

Learn how to connect your diagrams to GitHub repositories and Figma designs for living documentation

featuresintermediate⏱️8 min
Home/Documentation/Link External Resources

Learn how to connect your diagrams to GitHub repositories and Figma designs for living documentation

🔗 Connect Diagrams to Reality

Integration nodes let you bridge the gap between your architecture diagrams and the real-world resources they represent. Link services to their GitHub repositories, connect UI components to their Figma designs, and create documentation that stays in sync with reality.

What You'll Learn

What integration nodes are and why they matter

How to add GitHub and Figma integrations

Best practices for connecting external resources

Creating living, clickable documentation

💡 Pro Tip

Integration nodes transform static diagrams into interactive documentation hubs. When code or design files change, your team can click directly from the diagram to view the latest version.

Understanding Integrations

What Are Integration Nodes?

Integration nodes are special node types that link to external resources. They come in two flavors:

GitHub Integrations

Link to repositories, specific files, pull requests, or issues. Great for connecting architecture components to their source code.

Figma Integrations

Connect to design files, frames, or components. Perfect for linking UI components to their design specifications.

🔗 Integration Types

GitHub Integration Uses:

Repository overview links • Direct file navigation • Pull request references • Issue tracking connections

Figma Integration Uses:

Design file links • Specific frame references • Component library connections • Design system documentation

Integration Node Use Cases

Use Case: **Architecture Documentation**: Link each microservice to its repository **Design Systems**: Connect UI components to Figma design specs **Onboarding**: Help new team members navigate from diagrams to code **Code Reviews**: Reference specific files or PRs in architectural diagrams

Why Use Integrations?

Integration nodes solve a critical problem in technical documentation: the gap between diagrams and reality. Here's why they're powerful:

Key Benefits

Single Source of Truth - Diagrams link directly to actual code and designs

Faster Navigation - Click from architecture overview to implementation

Better Onboarding - New developers can explore codebase visually

Living Documentation - Links stay current as repositories evolve

Team Collaboration - Designers and developers share common reference

What's the primary benefit of integration nodes?

They make diagrams look prettier
They bridge diagrams and real-world resources
They automatically update code documentation
They replace Git version control

Working with Integrations

Adding GitHub Integrations

GitHub integrations let you link architecture components to their source code. Here's how to add them:

•

Open Integration Panel

Click "Add Integration" in the sidenav

•

Select GitHub Type

Choose GitHub from the integration options

•

Enter URL

Paste the GitHub URL (repository, file, PR, or issue)

•

Position Node

Place the integration node near related components

•

Connect with Edges

Draw connections to show relationships

Supported GitHub URL Formats

Repository: https://github.com/username/repo

File: https://github.com/username/repo/blob/main/path/to/file.ts

Pull Request: https://github.com/username/repo/pull/123

Issue: https://github.com/username/repo/issues/456

Connecting Service to Repository

typescript
// Example: Linking a service to its repository
// 1. Create a service node labeled "User Authentication Service"
// 2. Add GitHub integration with URL:
//    https://github.com/mycompany/auth-service

// 3. Connect with edge labeled "implemented in"

// Result: Clicking the GitHub node opens the repo
// Team members can jump from architecture to code instantly

Which GitHub URL format links to a specific file?

https://github.com/user/repo
https://github.com/user/repo/blob/main/src/file.ts
https://github.com/user/repo/pull/123
https://github.com/user/repo/issues/456

Adding Figma Integrations

Figma integrations connect your architecture to design files, perfect for frontend components and design systems.

•

Open Integration Panel

Click "Add Integration" in sidenav

•

Select Figma Type

Choose Figma from integration options

•

Enter Design URL

Paste Figma file or frame URL

•

Label Appropriately

Use design file name or component name

•

Connect to Components

Link UI components to their designs

Figma URL Examples

Design File: https://figma.com/file/abc123/Design-System

Specific Frame: https://figma.com/file/abc123/Design-System?node-id=123:456

Prototype: https://figma.com/proto/abc123/Mobile-App

Frontend Component Integration

Use Case: **Scenario**: Document your component library **Step 1**: Create nodes for each UI component (Button, Card, Modal) **Step 2**: Add Figma integration with design system URL **Step 3**: Connect components to design specs with "designed in" edges **Result**: Developers see implementation AND design in one view

Connecting Integrations to Nodes

Integration nodes become powerful when connected to your architecture. Use edges to show meaningful relationships:

"implemented in"

Connect services/components to their GitHub repos

"designed in"

Link UI components to Figma designs

"documented in"

Reference documentation files

"tracked in"

Link features to GitHub issues

"reviewed in"

Connect changes to pull requests

Common Integration Patterns

text
// Connection Pattern Examples:

// Backend Service → GitHub Repository
[User Service] --"implemented in"--> [GitHub: auth-service]

// Frontend Component → Figma Design
[Button Component] --"designed in"--> [Figma: Design System]

// Feature → GitHub Issue
[Payment Flow] --"tracked in"--> [GitHub: Issue #234]

// Architecture Change → Pull Request
[New API Gateway] --"reviewed in"--> [GitHub: PR #456]
⚡ Best Practice

Use consistent edge labels across your diagrams. This creates a predictable navigation experience for your team.

What's the best edge label for connecting a service to its repository?

"links to"
"implemented in"
"has code in"
"related to"

Quick Reference

Integration Best Practices

✅ Do's

Link every major service to its repository

Connect frontend components to Figma designs

Use descriptive edge labels ("implemented in", "designed in")

Keep URLs up-to-date as repositories evolve

Group related integrations visually

❌ Don'ts

Don't create integration nodes without connecting them

Don't use vague edge labels like 'related to'

Don't link to outdated or archived resources

Don't overcrowd diagrams with too many integrations

Common Use Cases

Microservices Architecture

Link each service to its repository • Connect API Gateway to API documentation • Reference deployment configs in infrastructure repos

Design Systems

Connect components to Figma design specs • Link style guides to design files • Reference component library documentation

Feature Development

Track features to GitHub issues • Link implementations to pull requests • Reference design mockups for new features

Team Onboarding

Create overview diagrams with repo links • Connect system components to their code • Link design components to Figma library

Keyboard Shortcuts

Add Integration

Press I to open integration panel

Select Node

Click to select integration node

Open in GitHub/Figma

Select integration node, then click "Open" in control panel

Delete Integration

Select integration node, then press Backspace

UI Elements

"Add Integration" Button

Located in sidenav, opens integration creation panel

Integration Type Selector

Choose between GitHub and Figma

URL Input Field

Paste GitHub or Figma URL

"Open in [Service]" Button

Opens linked resource in new tab (appears in control panel)

Integration Node Icon

Visual indicator showing GitHub/Figma icon

Next Steps

🎉 Congratulations!

You've mastered integration nodes! You can now:

✅ Connect diagrams to GitHub repositories and Figma designs

✅ Create living documentation that links to real resources

✅ Build clickable architecture diagrams

✅ Help teams navigate from overview to implementation

Ready to level up? Try these advanced features next:

💡 Pro Tips for Production Use

Link strategically - Connect high-level services to repos, not every tiny component

Update regularly - Review integration links quarterly to ensure they're current

Use conventions - Establish team standards for edge labels and URL formats

Combine with templates - Create templates with pre-configured integration patterns

8 of 10

Related Articles

Connect Your GitHub Account

Learn how to securely connect GitHub for enhanced integrations

referencebeginner
5 min

Templates

Create reusable node templates for consistency

featuresintermediate
7 min

Master Virtual Nodes

Create cross-level connections with virtual node references

featuresintermediate
9 min

On This Page

IntroductionUnderstanding IntegrationsWorking with IntegrationsQuick ReferenceNext Steps