GitHub

Connect GitHub so Deck Intelligence can read your product's code. Deck uses it to answer questions about how your product works, to check what customers report against the code, and to build a map of your product's pages and features. Deck only reads your code. It never writes to GitHub.

GitHub is a team source: an admin connects it once, and everyone in your organization can use it in Deck Intelligence.

Before You Start

• You need to be an admin of your Deck organization.
• Use a GitHub account that can read the repository you want Deck to use.
• Deck reads one repository and one branch per organization. Pick the branch your customers' product is built from, usually your main branch.

Connecting GitHub

1. Open Deck Intelligence and click the Connectors button beside the chat input.
2. Under Team, choose Connect for the team next to GitHub.
3. Authorize the connection in the popup. If nothing opens, allow pop-ups for Deck and try again.
4. In Set up GitHub for the team, enter the Repository as owner/repo (or paste a github.com link) and the Branch.
5. Choose Check and save. Deck checks that it can read that repository and branch before it saves. If the check fails, the message under the field says what to fix.

The GitHub permission covers the repositories your GitHub account can reach, but Deck reads only the repository and branch you set here.

Reviewing Your Product Map

Right after you save GitHub setup for the first time, or with a different repository or branch, the chat sends "Review our GitHub repo and recommend a product map setup." for you, and Deck starts reviewing your repository. You can also ask for a review at any time.

The review takes a few minutes. Deck reads one version of your repository and looks for:

• your apps and the pages a customer can open
• features, grouped from those pages, with what each one lets people do and the problems it solves
• public API endpoints, SDK methods, widgets, and command-line tools
• docs your customers read, in the repository or on a public help site
• product terms, and the words customers use for each feature

Deck then shows a recommended map: your apps, features, docs, the apps it left out (such as internal tools or test apps), and any questions. Reply with corrections, for example "Leave out the admin app" or "Group billing and invoices into one feature", and Deck revises the map.

When the map looks right, tell Deck to save it. A Product Map Needs Confirmation card appears. Approve it to save. Nothing from your code becomes part of the product map until an admin approves it.

Before GitHub is connected, Deck builds a simpler map from your public website and, if connected, PostHog. Pages found in your code replace the matching pages from those sources. See Product Map.

Keeping the Map Current

Each day, Deck updates the saved map from the latest version of your branch. New pages are added and described, and pages that no longer exist drop off. The features, docs, and product terms you confirmed stay as you saved them. Ask Deck to review the repository again when you want to change them.

Docs you confirmed in the review become searchable, so Deck Intelligence can answer how a feature is meant to work.

Asking About Your Code

Once GitHub is set up, anyone in your organization can ask Deck Intelligence about your code. For example:

• "Which file handles password resets?"
• "Customers say CSV exports time out. What does the export code do?"
• "Which pages make up the billing feature?"
• "How is the Slack integration meant to work?"

Deck lists and reads files from the latest version of your branch. When an answer uses a file, its citation opens that file on GitHub at the exact version Deck read.

Changing or Disconnecting GitHub

• Change the repository or branch: open Connectors, choose Settings next to GitHub, and save the new repository or branch. Deck clears the map it built from the old code and starts a new review.
• Reconnect: if GitHub shows that it rejected the connection, or that the admin who connected it left the organization, choose Reconnect.
• Disconnect: open Connectors, choose Add a connector, and choose Disconnect next to GitHub under For the whole team. Deck stops reading GitHub for everyone. Your setup is kept, so connecting again restores it.

Privacy and Security

• Deck only reads. It never writes to your repository.
• Deck never reads secret files, such as .env files (except .env.example), private keys, and certificates. It also skips binary files and files larger than 1 MB.
• A review copies one version of your repository into a temporary, isolated workspace with no internet access, and deletes it when the review ends.
• Deck doesn't store a GitHub token. The connection is held by Deck's connector provider.
• When the admin who connected GitHub leaves your organization, Deck removes that connection, and another admin needs to reconnect it.

Limits

• One repository and one branch per organization.
• A review can take up to about 10 minutes. Repositories larger than 200 MB can't be reviewed yet.
• Deck reads at most 400 lines of a file at a time.
• Reviews, and the descriptions Deck writes for new or changed pages, use credits from your organization's allocation. If credits run out during a review, the review stops.