diff --git a/fern/docs/configuration/doc-collections/github-repos.md b/fern/docs/configuration/doc-collections/github-repos.md index 71d0924..3c889c0 100644 --- a/fern/docs/configuration/doc-collections/github-repos.md +++ b/fern/docs/configuration/doc-collections/github-repos.md @@ -50,7 +50,7 @@ When auto-publish is enabled for your project: - Promptless automatically creates a new PR in your documentation repository with suggested changes - For GitHub PR triggers, the documentation PR is linked in a comment on the original code PR -- Optionally enable auto-merge to automatically merge documentation PRs as soon as they're created (nested checkbox under auto-publish in project settings) +- For [commit triggers](/docs/configuration/triggers/github-commits), you can enable auto-merge to automatically merge documentation PRs as soon as they're created (nested checkbox under auto-publish in project settings) ## Automated CI Check and Build Issue Resolution diff --git a/fern/docs/configuration/triggers.md b/fern/docs/configuration/triggers.md index 3377f26..3bcc09b 100644 --- a/fern/docs/configuration/triggers.md +++ b/fern/docs/configuration/triggers.md @@ -52,7 +52,7 @@ Need a trigger type that isn't currently supported? Contact us at [help@goprompt ## Auto-publish Mode -When auto-publish is enabled for your project, Promptless automatically creates pull requests in your documentation repository with suggested changes. You can optionally enable auto-merge to automatically merge documentation PRs as soon as they're created. +When auto-publish is enabled for your project, Promptless automatically creates pull requests in your documentation repository with suggested changes. For [commit triggers](/docs/configuration/triggers/github-commits), you can optionally enable auto-merge to automatically merge documentation PRs as soon as they're created. Auto-publish is available for GitHub-based documentation platforms. For CMS platforms like Zendesk or Intercom, documentation updates are created as drafts for review. diff --git a/fern/docs/configuration/triggers/github-commits.md b/fern/docs/configuration/triggers/github-commits.md index cd06868..bc43171 100644 --- a/fern/docs/configuration/triggers/github-commits.md +++ b/fern/docs/configuration/triggers/github-commits.md @@ -42,6 +42,23 @@ GitHub commit triggers are especially useful for: - **Direct-to-Main Workflows**: Support teams that commit directly to main branches - **Automated Updates**: Trigger documentation updates from automated commit processes +## Auto-merge Mode + +Automatically merge documentation PRs into the default branch as soon as they're created. + +Auto-merge requires auto-publish to also be enabled. + +Auto-merge is useful for: +- **Internal documentation**: When documentation PRs don't require human review +- **High-confidence workflows**: Teams that want full automation +- **Changelog-driven updates**: When you want changelog updates to publish immediately + +Enable auto-merge in your [project settings](https://app.gopromptless.ai/projects) by checking "Automatically merge Promptless suggestions into the default branch." This option is only available for commit triggers. + + + Project settings showing auto-publish and auto-merge checkboxes + + ## Setup Instructions To connect GitHub to Promptless, see the [GitHub Integration](/docs/integrations/github-integration) setup guide. diff --git a/fern/docs/configuration/triggers/github-prs.md b/fern/docs/configuration/triggers/github-prs.md index 1672e15..16acc40 100644 --- a/fern/docs/configuration/triggers/github-prs.md +++ b/fern/docs/configuration/triggers/github-prs.md @@ -66,7 +66,6 @@ Learn more about GitHub repository topics in the [GitHub documentation](https:// When auto-publish is enabled for your project: - Promptless automatically creates a new PR in your documentation repository with suggested changes - The documentation PR is linked in a comment on the original code PR -- Optionally enable auto-merge to automatically merge documentation PRs as soon as they're created ## Draft Pull Requests