Skip to main content

GitHub

GitHub accounts

How NookDocs connects to GitHub — account authorization, the App installation, and per-project repo connections — and how to manage them from Settings → Integrations.

NookDocs talks to GitHub through two account-level grants plus a per-project repo connection. Understanding the three layers makes connecting, disconnecting, and troubleshooting predictable.

Adding, managing, and removing a GitHub account are browser-only actions performed under Settings → Integrations — there is no NookDocs API endpoint for them. The OAuth authorization and the GitHub App installation both live at the account level (user or org); only the repo binding is per-project. Removing an account uninstalls the App, which disconnects every project on that account and purges their synced docs, but never modifies repos on GitHub. GitHub-side changes (uninstall, repo removal, rename, reinstall) are reconciled automatically via webhooks — the dashboard does not need manual repair.

The three layers

Authorization (OAuth)

Identifies you and lets NookDocs act on your behalf — create repos, add/remove repos from the App. Account-wide, granted once. Not per-repo.

App installation

Grants the NookDocs GitHub App access to specific repos on an account. One installation per account, shared by every project on that account. Not per-project.

Project connection

The only per-project piece: which repo (and branch, and monorepo subfolder) a project syncs from. The installation is resolved from the repo.

Both the authorization and the installation live at the account level (your personal account or an org). Two projects can connect different repos on the same account and share one installation. The project only ever owns a repo binding.

Settings → Integrations

The Integrations tab in your global Settings lists every GitHub account you've connected:

ColumnMeaning
AccountThe GitHub user or org the App is installed on
TypeUser or Org
AuthorizedWhether we hold a valid OAuth token (lets us create repos / manage access on your behalf)
ProjectsHow many of your projects sync from this account

Add a GitHub account

Add GitHub account opens GitHub's combined Install & Authorize screen. Pick the account and the repos to grant — narrow selection is recommended. You're returned to Integrations with the account connected.

Manage on GitHub

Jumps to the App's installation settings on GitHub, where you can change which repos it can access.

Remove an account

Remove uninstalls the NookDocs App from that account. We lose access to all its repos, so every project syncing from it is disconnected and its synced docs are purged. The confirmation tells you how many projects are affected. Your repos on GitHub are never modified.

Disconnect a project vs. remove an account

Two different scopes — pick the one that matches your intent:

Disconnect one project

Settings → Git → Disconnect on a project. Unlinks just that repo and removes its synced docs. The App stays installed for your other projects.

Remove the whole account

Settings → Integrations → Remove. Uninstalls the App from the account, disconnecting every project on it at once.

What happens automatically

NookDocs reconciles GitHub-side changes via webhooks — you don't have to keep the dashboard in sync by hand:

  • Uninstall the App (on GitHub) → every project on it is disconnected and purged.

  • Remove a repo from the App's access → projects bound to that repo are disconnected and purged.

  • Delete or rename a repo → bound projects are updated/cleaned accordingly.

  • Reinstall the App → a reinstall mints a new installation id; NookDocs resolves the live installation per repo, so connections keep working without manual repair.

Removing an account or uninstalling the App removes our access and our synced copy of the docs — never anything in your repository. Reconnect any time to pull everything back in.

Next

Self-hosted repo

Connect your own repo, pick a branch, and disconnect when needed.

Monorepo

Point a project at a docs subfolder of a larger repo.

Was this page helpful?

Last updated August 11, 2026