GitHub Integration Overview

Connect your ArchDoc organization to GitHub to sync documents to your repositories.

What is GitHub Integration?

The GitHub integration allows you to:

• Sync documents to a GitHub repository
• Store documentation as Markdown in version control
• Track changes alongside your code
• Collaborate using GitHub's ecosystem

Benefits

Version Control for Docs

• Documents stored as Markdown files
• Full Git history for changes
• Branch and merge workflows

Co-located with Code

• Keep documentation with related code
• Single source of truth
• Developers find docs easily

Familiar Workflow

• Use GitHub's review features
• Link to PRs and commits
• Leverage existing tooling

Plan Requirements

How It Works

graph LR
    A[ArchDoc Document] --> B[Sync to GitHub]
    B --> C[Repository]
    C --> D[Markdown File]

Connection Flow

1. Install App: Admin installs the ArchDoc GitHub App on their GitHub account or organization
2. Select Repository: Choose which repo to sync to
3. Sync Documents: Push documents to the repository

What Gets Synced

Getting Started

Who Can Use GitHub Integration

*Members can sync documents if integration is set up by an Admin.

Security

OAuth Permissions

• We request minimal GitHub permissions
• Access only to selected repositories
• You can revoke access anytime

Token Storage

• Access tokens are encrypted
• Stored securely in our database
• Never exposed to users

Repository Access

• Choose public or private repos
• We only access the selected repo
• No access to other repos or data

Prerequisites

Before setting up:

• ✅ Base or Premium plan
• ✅ Admin role in ArchDoc
• ✅ GitHub account
• ✅ Access to the target repository

Integration Status

View your integration status:

1. Go to Dashboard > Integrations
2. See the GitHub section
3. Shows connected account and repository

Status Indicators

Next Steps

1. Connect your GitHub account
2. Select a repository
3. Start syncing documents