Skip to content

docs: Update fourth screenshot in GitHub integration documentation #77

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: Update fourth screenshot in GitHub integration documentation #77

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
db2bec3
Documentation updates from Promptless
promptless[bot] Sep 8, 2025
f5fdf6a
Update documentation based on feedback
promptless[bot] Sep 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
85 changes: 25 additions & 60 deletions fern/docs/integrations/github.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,97 +1,62 @@
# GitHub Integration

**Used for: Triggers, Context, and Publishing**
**Used For**: Triggers, Context, and Publishing

Promptless integrates with GitHub through our official GitHub App, providing secure access to your repositories for documentation automation.
Promptless integrates directly with GitHub to allow full integration with your source code.

<Info>
**GitHub Enterprise Users**: If you're using GitHub Enterprise Server or GitHub Enterprise Cloud with restricted third-party app access, see our [GitHub Enterprise Setup Guide](/docs/integrations/github-enterprise-integration) for custom GitHub App configuration instructions.
**Note**: GitHub Enterprise users may require a custom app install. Please contact us or see [GitHub Enterprise Setup Guide](/docs/integrations/github-enterprise-integration).
</Info>

## Installation

1. Click "Connect GitHub" from the [integrations page](https://app.gopromptless.ai/integrations).
1. From the [integrations page](https://app.gopromptless.ai/integrations), click the "Connect GitHub" button.
<Frame>
<img src="../assets/integrations-blank.png" alt="Integrations Page" />
<img src="https://promptless-customer-doc-assets.s3.amazonaws.com/docs-images/org_2lvkgU9erOFxYhtEVVC0ymPrPdF/1757004622-integrations-page-blank.png" alt="Integrations Page" />
</Frame>

2. Select which GitHub org you want to install Promptless into.
2. You'll be redirected to GitHub to install the Promptless GitHub App. Select your GitHub organization.
<Frame>
<img src="../assets/github-select-org.png" alt="Integrations Page" />
<img src="https://promptless-customer-doc-assets.s3.amazonaws.com/docs-images/org_2lvkgU9erOFxYhtEVVC0ymPrPdF/1757004622-github-select-org.png" alt="Select GitHub Organization" />
</Frame>

3. Select which repositories you want to give Promptless access to. Typically, this will be your source code and your documentation repo (if your docs are in GitHub).
3. Select which repositories you want Promptless to have access to. You can always add more repositories later.
<Frame>
<img src="../assets/github-select-repos.png" alt="Integrations Page" />
<img src="https://promptless-customer-doc-assets.s3.amazonaws.com/docs-images/org_2lvkgU9erOFxYhtEVVC0ymPrPdF/1757004622-github-select-repos.png" alt="Select Repositories" />
</Frame>

4. Verify that Promptless is connected in the integrations page.
4. Once installed, you'll be redirected back to the integrations page where you can see your GitHub account connected.
<Frame>
<img src="../assets/integrations-complete.png" alt="Integrations Page" />
<img src="https://promptless-customer-doc-assets.s3.amazonaws.com/docs-images/org_2lvkgU9erOFxYhtEVVC0ymPrPdF/1757004622-github-integrations-complete-dashboard.png" alt="Integrations Page with connected services" />
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Promptless please make sure this page is written with very simple language

</Frame>

## Managing Repository Access After Installation
## Adding more repositories later

After the initial installation, you may need to add new repositories or modify which repositories Promptless can access. You can manage this directly through your GitHub organization settings:
1. Visit your GitHub organization settings at `https://github.com/organizations/<your-org>/settings/installations`
2. Click on "Third-party Access" in the left sidebar, then "GitHub Apps"

1. Navigate to your GitHub organization settings
2. Go to "Third-party Access" → "GitHub Apps"
3. Find "Promptless" in the list and click "Configure"
4. In the "Repository access" section, you can:
- Switch between "All repositories" and "Only select repositories"
- Add or remove specific repositories using the "Select repositories" dropdown
- Remove repositories by clicking the "×" next to their names
![](https://promptless-customer-doc-assets.s3.amazonaws.com/docs-images/org_2lvkgU9erOFxYhtEVVC0ymPrPdF/1757004622-github-org-settings.png)

3. Find "Promptless" in the list and click "Configure" next to it

<Frame>
<img src="https://promptless-customer-doc-assets.s3.amazonaws.com/docs-images/org_2lvkgU9erOFxYhtEVVC0ymPrPdF/bc05f421-e940-4f84-b442-6f9181a0eab3-github-app-repository-management.png" alt="GitHub App Repository Management" />
<img src="https://promptless-customer-doc-assets.s3.amazonaws.com/docs-images/org_2lvkgU9erOFxYhtEVVC0ymPrPdF/1757004622-github-configure-promptless.png" alt="Configure Promptless" />
</Frame>

5. Click "Save" to apply your changes

After updating repository access, the new repositories will be available when creating or editing projects in Promptless. Note that it may take a few minutes for the changes to be reflected in the Promptless dashboard. If you don't see newly added repositories immediately, you may need to click the "refresh repos" icon in the integrations page to update the repository list.

## Project Setup and Permissions

After setting up the integration, you'll be able to create a project in the [projects page](https://app.gopromptless.ai/projects). When creating a project, you'll be able to select trigger repositories and documentation repositories. Promptless will have read-only access to the repositories that you select as trigger repositories, and will have write access to the repositories that you select as documentation repositories.

For example, in the below example, Promptless is only able to read the `promptless` and `promptless-dashboard` repos, but is able to read and write to the `promptless-docs` repo.
4. In the "Repository access" section, click "Only select repositories" and add any additional repositories

<Frame>
<img src="../assets/github-project.png" alt="Project Setup" />
<img src="https://promptless-customer-doc-assets.s3.amazonaws.com/docs-images/org_2lvkgU9erOFxYhtEVVC0ymPrPdF/1757004622-github-select-more-repos.png" alt="Add Repositories" />
</Frame>

## Trigger Events in Pull Request Descriptions

When Promptless creates a pull request for documentation updates, it automatically includes a list of the trigger events that led to those changes in the PR description. This provides valuable context for reviewers and creates clear traceability between documentation updates and their originating events.

The trigger events section in the PR description includes:
- Links back to the original source (e.g., Slack threads, GitHub PRs, support tickets)
- Brief descriptions of what triggered the documentation update
- Easy navigation to review the context that prompted the changes
5. Remember to click "Save" or "Update"

This feature helps you understand why documentation changes were made and provides a clear audit trail for all updates.
## Creating a Project

## Directory-Specific Triggers
Once your GitHub account is connected, you can create a project in the [projects page](https://app.gopromptless.ai/projects).

You can configure Promptless to only trigger when changes are made to specific directories within your repositories. This is particularly useful when you want to focus documentation updates on changes to certain parts of your codebase, such as changelog directories.

To set up directory-specific triggers:

1. When creating or editing a project, select the GitHub trigger option
2. Check the "Choose specific directories to trigger this project" option
3. Enter the directory paths you want to monitor, separating multiple paths with commas
4. Save your project configuration
Select the repositories you want to use as trigger sources and document sources. Trigger repositories are the ones where Promptless will monitor for changes and events to trigger documentation updates. Documentation repositories are where your documentation currently lives and where Promptless will write documentation during the Publish step.

<Frame>
<img src="https://promptless-customer-doc-assets.s3.amazonaws.com/docs-images/org_2lvkgU9erOFxYhtEVVC0ymPrPdF/47a14116-12d1-4a1d-beae-875c1d182124-github-directory-trigger.png" alt="Directory-specific GitHub trigger configuration" />
<img src="https://promptless-customer-doc-assets.s3.amazonaws.com/docs-images/org_2lvkgU9erOFxYhtEVVC0ymPrPdF/3367872715-github-project.png" alt="Project Setup" />
</Frame>

Once configured, your specified trigger directories will be visible in the project list view, making it easy to see which directories are being monitored for each project.

When trigger directories are specified, only PRs that contain changes to those directories will be considered, and updates to other files will be ignored.

## Authentication Model

Promptless uses the official [GitHub App specification](https://docs.github.com/en/apps/creating-github-apps/about-creating-github-apps) to authenticate with GitHub. Promptless authenticates securely with JWTs generated by the GitHub App installation.

This ensures that Promptless has read and write access to the repositories that you select, and that either you or Promptless can revoke access at any time.