Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions fern/docs/changelogs/2025-11.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ title: November 2025

**What's New:**

* **GitHub Commit Triggers:** Promptless now runs on direct commits to your default branch—perfect for teams that skip pull requests. Select "GitHub Commit" when creating or editing a project, choose your repository, and Promptless analyzes commits to your default branch just like it does for PRs. Commits from PRs we already processed are automatically skipped.

* **Rich Slack Notifications for Quick Review and Publishing:** When Promptless creates documentation suggestions, you get rich notifications in Slack showing the suggestion title, description, assigned team members, trigger source, and files changed. Use the "Publish" button to merge small, straightforward suggestions directly from Slack, or click "Open PR" to review changes in detail on GitHub or in the Promptless dashboard.

<Frame>
Expand Down
14 changes: 12 additions & 2 deletions fern/docs/core-concepts/triggers.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Triggers are events that initiate automated documentation updates in Promptless.

<CardGroup cols={2}>
<Card title="GitHub/Bitbucket/GitLab" icon="fa-code-pull-request">
Automatically triggered when PRs/MRs are opened in your source repositories
Automatically triggered when PRs/MRs are opened or commits are pushed to your source repositories
</Card>

<Card title="Slack Integration" icon="brands slack">
Expand All @@ -16,13 +16,23 @@ Triggers are events that initiate automated documentation updates in Promptless.

### GitHub / Bitbucket / GitLab

Promptless automatically monitors your specified source repositories for new pull requests. When a PR/MR is opened, the system analyzes the changes to determine if documentation updates are needed.
Promptless automatically monitors your specified source repositories for new pull requests or direct commits. When a PR/MR is opened or a commit is pushed to your default branch, the system analyzes the changes to determine if documentation updates are needed.

During analysis, Promptless processes information such as the code diff, PR title, and PR description to understand the context and scope of changes. This information is used solely for generating documentation suggestions and is not stored by Promptless.

You can configure specific directories to monitor, focusing documentation efforts on relevant parts of your codebase.

<AccordionGroup>
<Accordion title="GitHub Commit Triggers">
In addition to monitoring pull requests, GitHub can be configured to trigger on direct commits to your default branch. This is useful for teams that commit directly to main/master without using pull requests.

When you create or edit a project, select "GitHub Commit" as your trigger type and choose which repository to monitor. Promptless will analyze commits to your default branch and automatically skip commits that originated from pull requests we already processed.

<Frame>
<img src="https://promptless-customer-doc-assets.s3.amazonaws.com/docs-images/org_2lvkgU9erOFxYhtEVVC0ymPrPdF/github-commit-trigger-project-config.png" alt="GitHub Commit trigger project configuration showing branch monitoring" />
</Frame>
</Accordion>

<Accordion title="Auto-publish Mode">
When auto-publish is enabled for your project:
- Promptless automatically creates a new PR with suggested documentation changes
Expand Down
78 changes: 22 additions & 56 deletions fern/docs/integrations/github.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

**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 with GitHub through our official GitHub App, providing secure access to your repositories for documentation automation. You can trigger documentation updates from pull requests or direct commits to your default branch.

<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.
Expand Down Expand Up @@ -63,70 +63,36 @@ After the initial installation, you may need to add new repositories or modify w

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.

<Frame>
<img src="../assets/github-project.png" alt="Project Setup" />
</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

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

## Directory-Specific Triggers

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

<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" />
</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.

## Automated CI Check and Build Issue Resolution

When Promptless opens a documentation PR, it automatically monitors the pull request for quality issues. If CI checks fail, linting tools report errors, Vale rules trigger warnings, or your documentation hosting provider detects broken links or build problems, Promptless will automatically analyze the issues and push fixes directly to the PR branch.

This automated issue resolution works seamlessly with your existing GitHub workflow - there's no additional configuration needed. Quality problems get resolved in the background while you focus on content rather than troubleshooting technical issues.

## 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.
## Frequently Asked Questions

### How do I add more repositories after installing the GitHub integration?
## What You Can Do with GitHub

Once connected, you can use GitHub for:

Add additional repositories anytime by visiting your GitHub organization settings. In GitHub, head to `Settings -> Third-party Access -> GitHub Apps` then find the Promptless GitHub App and click "Configure." Add or remove repositories in the "Repository access" section, then click "Save." You'll be able to choose from the newly added repositories when creating or editing your Promptless projects.
- **[Triggers](/docs/configuration/triggers)**: Monitor pull requests and commits for documentation updates
- **[Context Sources](/docs/configuration/context-sources/github)**: Search code repositories and issues for technical context
- **[Doc Collections](/docs/configuration/doc-collections/github-repos)**: Publish documentation updates to GitHub-based platforms

### Can I remove GitHub repository access from Promptless?
## Frequently Asked Questions

You can remove access to specific repositories or even uninstall the integration entirely from the same "Configure" page in your GitHub organization settings. Click the `×` next to a repository name to remove it from the Promptless GitHub App, or click the `Uninstall` button at the bottom of the page to remove the app entirely.
<AccordionGroup>
<Accordion title="How do I add more repositories after installing the GitHub integration?">
Add additional repositories anytime by visiting your GitHub organization settings. In GitHub, head to `Settings -> Third-party Access -> GitHub Apps` then find the Promptless GitHub App and click "Configure." Add or remove repositories in the "Repository access" section, then click "Save." You'll be able to choose from the newly added repositories when creating or editing your Promptless projects.
</Accordion>

### How long does it take for repository changes to appear in Promptless?
<Accordion title="Can I remove GitHub repository access from Promptless?">
You can remove access to specific repositories or even uninstall the integration entirely from the same "Configure" page in your GitHub organization settings. Click the `×` next to a repository name to remove it from the Promptless GitHub App, or click the `Uninstall` button at the bottom of the page to remove the app entirely.
</Accordion>

It may take a few minutes for repository updates in the GitHub App to be reflected in your Promptless dashboard. If you don't see newly added repositories right away when creating or editing projects, click the "refresh repos" icon in the integrations page.
### Can I connect multiple GitHub organizations to one Promptless account?
<Accordion title="How long does it take for repository changes to appear in Promptless?">
It may take a few minutes for repository updates in the GitHub App to be reflected in your Promptless dashboard. If you don't see newly added repositories right away when creating or editing projects, click the "refresh repos" icon in the integrations page.
</Accordion>

Yes. After connecting your first GitHub organization, you can add more by clicking "Connect another GitHub Org" on the integrations page. Each organization appears as its own card, and repositories from all connected organizations are available when setting up projects.
<Accordion title="Can I connect multiple GitHub organizations to one Promptless account?">
Yes. After connecting your first GitHub organization, you can add more by clicking "Connect another GitHub Org" on the integrations page. Each organization appears as its own card, and repositories from all connected organizations are available when setting up projects.
</Accordion>
</AccordionGroup>