diff --git a/fern/docs/changelogs/2025-11.md b/fern/docs/changelogs/2025-11.md index 11fa2ed..9e14720 100644 --- a/fern/docs/changelogs/2025-11.md +++ b/fern/docs/changelogs/2025-11.md @@ -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. diff --git a/fern/docs/core-concepts/triggers.md b/fern/docs/core-concepts/triggers.md index e69de29..81e41e9 100644 --- a/fern/docs/core-concepts/triggers.md +++ b/fern/docs/core-concepts/triggers.md @@ -0,0 +1,62 @@ +# Triggers + +Triggers are events that initiate automated documentation updates in Promptless. They're designed to integrate seamlessly into your existing workflow, minimizing friction when creating and maintaining documentation. + +## Supported Triggers + + + + Automatically triggered when PRs/MRs are opened or commits are pushed to your source repositories + + + + Trigger updates from Slack conversations and support threads + + + +### GitHub / Bitbucket / GitLab + +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. + + + + 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. + + + GitHub Commit trigger project configuration showing branch monitoring + + + + + When auto-publish is enabled for your project: + - Promptless automatically creates a new PR with suggested documentation changes + - The documentation PR is linked in a comment on the original code PR + + + + +Promptless automatically skips draft pull requests. Documentation updates are only triggered when the pull request is marked as ready for review. + + +### Slack Integration + +Slack integration enables documentation updates directly from your team conversations. This is particularly useful for support conversations or internal discussions where questions arise that could be better addressed in your documentation. + +**Trigger methods:** +- **Message Action**: Use the Promptless message shortcut on any Slack message to trigger documentation analysis +- **Mentions**: Tag @Promptless in a channel to request documentation updates based on the conversation context +- **Passive Listening** (optional): Enable automatic monitoring of specific channels for hands-free documentation updates. You can configure it in product-releases channel, or customer-support channels. + +#### Image Processing in Slack Threads + +When triggered in threads containing images, Promptless analyzes both text and visual content. Relevant images are automatically included in documentation updates, securely stored, and formatted for your documentation platform. + + +Need a trigger type that isn't currently supported? Contact us at [help@gopromptless.ai](mailto:help@gopromptless.ai) - we regularly add new trigger types based on user feedback. + diff --git a/fern/docs/integrations/github.mdx b/fern/docs/integrations/github.mdx index cd7ab88..639247d 100644 --- a/fern/docs/integrations/github.mdx +++ b/fern/docs/integrations/github.mdx @@ -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. **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.