Connections
Connections contain information that Doc Holiday leverages when creating documentation and release notes.
Doc Holiday analyzes data from your connected repositories, including historical commit information and prior changes. When generating documentation or release notes (such as when responding to ambiguous requests or major file updates), Doc Holiday attempts to retrieve relevant context from previous work and integrates commit summaries, messages, and diffs, where available, for more accurate and comprehensive documentation.
Currently Supported
GitHub
GitHub repositories are supported as both sources and destinations of information. The repository URL provided must be accessible to the GitHub application deployed within your organization. Branches can be specified for Doc Holiday-generated pull requests to write to; if the field is left empty, it will default to ‘main’.
GitHub connections fully support automation triggers for workflow run events (GitHub Actions). When creating a GitHub connection, Doc Holiday will automatically subscribe to workflow run webhook events, enabling you to trigger documentation and release note generation automatically when workflows complete in your repository. When configuring Publications, you can select specific workflow files to monitor as automation triggers.
To create a GitHub connection:
- Go to the Connections screen (https://app.doc.holiday/connections), click the ‘Add Connection’ button in the upper right corner, and select ‘GitHub’ from the Provider dropdown.
- Provide a recognizable name and select which GitHub repository you want to make the connection for from the dropdown menu. It will automatically be populated with all repositories that the GitHub application was given permission to access at installation.
Note: Only repositories accessible via your Doc Holiday application (up to 100 repositories per organization) will appear in the selection list. If you have more than 100 repositories, only the first 100 accessible repos will be shown.
GitLab
GitLab repositories are supported as both sources and destinations of information. The repository URL provided must be accessible to the GitLab application deployed within your organization. Branches can be specified for Doc Holiday-generated pull requests to write to; if the field is left empty, it will default to ‘main’.
To create a GitLab connection:
- In GitLab, create a project access token and save the token generated for later use.
- Go to the Connections screen (https://app.doc.holiday/connections), click the ‘Add Connection’ button in the upper right corner, and select ‘GitLab’ from the Provider dropdown.
- Give the connection a recognizable name, enter the name of the GitLab project, and paste in the access token you copied previously.
Linear
Linear is supported as a project management integration. Doc Holiday can access and automate workflows based on Linear issues, comments, messages, and webhook events. Doc Holiday will react to new issues, new comments, or editing existing comments in Linear.
Note: Linear merge events are not yet supported.
To create a Linear connection:
- In Linear, create an API key with the required permissions for integration.
- Go to the Connections screen (https://app.doc.holiday/connections), click the ‘Add Connection’ button in the upper right corner, and select ‘Linear’ from the Provider dropdown.
- Enter a name for the connection and paste the Linear API key in the field provided.
Google Drive
Google Drive is supported as a source of information, as well as a way to host style guides used (either globally or on a per-Publication basis). Authentication is created using service account credentials.
To create a Google Drive connection:
- Ensure the Google Drive API is enabled within the Google Cloud console.
- Create a service account. It can be fairly low-permissioned (e.g. a basic viewer or editor role).
- Once the service account has been created, please create a key for it. The key will generate a downloadable JSON file containing the credentials.
- Go to the Connections screen (https://app.doc.holiday/connections), click the ‘Add Connection’ button in the upper right corner, and select ‘Google Drive’ from the Provider dropdown.
- Copy and paste the contents of the downloaded JSON file, or upload the file into the field.
Note: When the service account above was created, it generated a email-y name, like doc-holiday@laptop-llm.iam.gserviceaccount.com. Please make sure any documents Doc Holiday needs to read are shared with that username / address.
Confluence
Confluence is supported as a source of documentation and wiki content for Doc Holiday. Content from your connected Confluence workspaces can be referenced for context during documentation and release note generation.
To create a Confluence connection:
- In Confluence, create or use an existing account with the appropriate API access.
- Generate or retrieve a Confluence API token.
- Go to the Connections screen (https://app.doc.holiday/connections), click the ‘Add Connection’ button in the upper right corner, and select ‘Confluence’ from the Provider dropdown.
- Enter a name for your Confluence connection and provide:
- Site URL (e.g.,
https://yourdomain.atlassian.net
) - Username (email)
- API token
- Site URL (e.g.,
Note: Only spaces, pages, and content accessible via the provided credentials can be indexed by Doc Holiday.
Notion
Notion is supported as a source of context for Doc Holiday. Product specs, design docs, and any other supplementary content shared from your connected Notion workspaces is used in the indexing, context building, and content generation process.
To create a Notion connection:
- In Notion, create an integration and grab the integration key generated for use in Doc Holiday.
- Go to the Connections screen (https://app.doc.holiday/connections), click the ‘Add Connection’ button in the upper right corner, and select ‘Notion’ from the Provider dropdown.
- Enter a name for your Notion connection and paste the integration key copied previously.
External Documentation
The External Documentation connection type allows you to connect a public documentation repository to Doc Holiday. This provides additional reference context for generating high-quality release notes and for updating or synthesizing new documentation. Doc Holiday will crawl and index the contents of the provided documentation site, making it available for AI-assisted generation and updates.
To create an External Documentation connection:
- Go to the Connections screen (https://app.doc.holiday/connections), click the ‘Add Connection’ button in the upper right corner, and select ‘External Documentation’ from the Provider dropdown.
- Enter a name for your connection and the public URL of the root documentation site (e.g., your Docusaurus or Hugo docs deployment).
- If the documentation site requires authentication, provide your credentials:
- For Basic authentication, supply the username and password in the designated fields.
- For Bearer authentication, provide the access token in the bearer token field.
- For public, unauthenticated sites, simply provide the URL without any credentials.
Note: Doc Holiday will securely store and encrypt all provided authentication details; passwords, tokens, and secrets are never exposed in logs or documentation. Only the fact that authentication was used (and its type) may be recorded for auditing and transparency.