From 1dbfc1daf364ec63da1ee507bd7748fa1cb5bcd7 Mon Sep 17 00:00:00 2001 From: "promptless[bot]" Date: Thu, 19 Mar 2026 03:54:17 +0000 Subject: [PATCH 1/4] Add documentation for customizing notifications via Long-Term Context Introduces a new page explaining how customers can customize Promptless notification behavior by editing doc_workflow/notification_skill.md in their organization's Long-Term Context. Covers notification defaults, templates, tone, delivery preferences, and Slack-specific features. --- .../customizing-notifications.mdx | 70 +++++++++++++++++++ src/lib/generated/sidebar.json | 4 ++ 2 files changed, 74 insertions(+) create mode 100644 src/content/docs/docs/configuring-promptless/customizing-notifications.mdx diff --git a/src/content/docs/docs/configuring-promptless/customizing-notifications.mdx b/src/content/docs/docs/configuring-promptless/customizing-notifications.mdx new file mode 100644 index 00000000..0f639c4b --- /dev/null +++ b/src/content/docs/docs/configuring-promptless/customizing-notifications.mdx @@ -0,0 +1,70 @@ +--- +title: Customizing Notifications +description: >- + Configure how Promptless notifies your team about documentation suggestions +slug: docs/configuring-promptless/customizing-notifications +sidebar: + hidden: false + order: 15 +--- +import Note from '@components/fern/Note.astro'; +import Tip from '@components/fern/Tip.astro'; + +Promptless sends notifications to your team when documentation suggestions are ready for review. You can customize these notifications by editing a configuration file in your organization's Long-Term Context. + +## What is Long-Term Context? + +Long-Term Context (LTC) is where Promptless stores persistent configuration and preferences for your organization. It includes settings that influence how Promptless behaves across all documentation projects, including notification preferences. + +Your Promptless team can help you access and configure your Long-Term Context files. Contact us at [help@gopromptless.ai](mailto:help@gopromptless.ai) to get started. + +## Notification Configuration File + +Notification preferences are stored in the `doc_workflow/notification_skill.md` file within your Long-Term Context. When you first customize notifications, Promptless creates this file with sensible defaults. + +### What You Can Customize + +The notification configuration file lets you control: + +- **Notification defaults**: Set your preferred notification channels and timing +- **Message templates**: Customize how suggestion summaries appear in notifications +- **Tone and style**: Adjust the voice and formality of notification messages +- **Delivery preferences**: Configure which events trigger notifications and how they're formatted + +### Example Customizations + +Here are some common ways teams customize their notifications: + +**Change the notification tone:** +``` +Use a casual, friendly tone in all notification messages. +Avoid formal language like "please be advised" or "for your review." +``` + +**Customize message content:** +``` +Always include the number of files changed in the notification summary. +Mention the trigger source (PR, Slack message, etc.) prominently. +``` + +**Set delivery preferences:** +``` +Only send notifications for suggestions that modify more than one file. +Include diff file attachments for all Slack notifications. +``` + +## Slack Notification Features + +When you have the [Slack integration](/docs/integrations/slack-integration) connected, Promptless sends rich notifications with: + +- **Interactive buttons**: Quickly publish suggestions or open PRs for review directly from Slack +- **Diff file attachments**: See the full diff of documentation changes in a thread reply +- **Channel support**: Receive notifications in specific channels by name, not just by ID + + + Promptless automatically detects protected branches in your documentation repository. When detected, Slack notifications show "Open PR" or "View PR" buttons instead of "Publish" to prevent merge errors. + + +## Getting Help + +Need help configuring your notification preferences? Contact us at [help@gopromptless.ai](mailto:help@gopromptless.ai) and we'll help you set up the customizations that work best for your team. diff --git a/src/lib/generated/sidebar.json b/src/lib/generated/sidebar.json index c8b02ed2..7258af8e 100644 --- a/src/lib/generated/sidebar.json +++ b/src/lib/generated/sidebar.json @@ -97,6 +97,10 @@ "slug": "docs/configuring-promptless/doc-collections/git-hub-repos-docs-as-code" } ] + }, + { + "label": "Customizing Notifications", + "slug": "docs/configuring-promptless/customizing-notifications" } ] }, From 3d6cfac3303d34c812e10f1856f53cad8d954323 Mon Sep 17 00:00:00 2001 From: "promptless[bot]" Date: Fri, 20 Mar 2026 22:54:31 +0000 Subject: [PATCH 2/4] Update button name from 'Open PR' to 'Create PR' Reflects the button label change introduced in Promptless PR #2681. Co-Authored-By: Claude Opus 4.6 --- .../docs/configuring-promptless/customizing-notifications.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/content/docs/docs/configuring-promptless/customizing-notifications.mdx b/src/content/docs/docs/configuring-promptless/customizing-notifications.mdx index 0f639c4b..c8e90ac0 100644 --- a/src/content/docs/docs/configuring-promptless/customizing-notifications.mdx +++ b/src/content/docs/docs/configuring-promptless/customizing-notifications.mdx @@ -62,7 +62,7 @@ When you have the [Slack integration](/docs/integrations/slack-integration) conn - **Channel support**: Receive notifications in specific channels by name, not just by ID - Promptless automatically detects protected branches in your documentation repository. When detected, Slack notifications show "Open PR" or "View PR" buttons instead of "Publish" to prevent merge errors. + Promptless automatically detects protected branches in your documentation repository. When detected, Slack notifications show "Create PR" or "View PR" buttons instead of "Publish" to prevent merge errors. ## Getting Help From 3e29553bcdeb91003ad6666fdd71dec5ea15cd2a Mon Sep 17 00:00:00 2001 From: Prithvi Ramakrishnan Date: Mon, 23 Mar 2026 18:18:59 +0000 Subject: [PATCH 3/4] {"committer_name": "user_2lkm8iLz0zNLtpxfPLNuEme54nw", "committer_type": "CommitterType.USER", "files_deleted": [], "files_updated": ["src/lib/generated/sidebar.json"]} --- src/lib/generated/sidebar.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/lib/generated/sidebar.json b/src/lib/generated/sidebar.json index 5e21e575..7258af8e 100644 --- a/src/lib/generated/sidebar.json +++ b/src/lib/generated/sidebar.json @@ -35,7 +35,7 @@ "label": "Triggers", "items": [ { - "label": "Overview", + "label": "Triggers", "slug": "docs/configuring-promptless/triggers" }, { From 309c53ac00375442b9d8687efa5966f7f9243896 Mon Sep 17 00:00:00 2001 From: "promptless[bot]" Date: Wed, 1 Apr 2026 20:31:53 +0000 Subject: [PATCH 4/4] Update notification preferences file path and documentation - Rename file reference from notification_skill.md to notification_preferences.md - Update description to reflect simplified preferences scaffold - Add migration note for existing notification_skill.md files - Adjust customization examples to match new preferences-focused approach Related: Promptless/promptless#2842 --- .../customizing-notifications.mdx | 35 ++++++++++--------- 1 file changed, 19 insertions(+), 16 deletions(-) diff --git a/src/content/docs/docs/configuring-promptless/customizing-notifications.mdx b/src/content/docs/docs/configuring-promptless/customizing-notifications.mdx index c8e90ac0..14fee234 100644 --- a/src/content/docs/docs/configuring-promptless/customizing-notifications.mdx +++ b/src/content/docs/docs/configuring-promptless/customizing-notifications.mdx @@ -18,39 +18,42 @@ Long-Term Context (LTC) is where Promptless stores persistent configuration and Your Promptless team can help you access and configure your Long-Term Context files. Contact us at [help@gopromptless.ai](mailto:help@gopromptless.ai) to get started. -## Notification Configuration File +## Notification Preferences File -Notification preferences are stored in the `doc_workflow/notification_skill.md` file within your Long-Term Context. When you first customize notifications, Promptless creates this file with sensible defaults. +Notification preferences are stored in the `doc_workflow/notification_preferences.md` file within your Long-Term Context. This file is a lightweight scaffold where you add overrides and customizations—Promptless handles the underlying templates and message formatting automatically. + + + If your organization previously used a `notification_skill.md` file, Promptless automatically migrates it to the new `notification_preferences.md` format. Your customizations are preserved during migration. + ### What You Can Customize -The notification configuration file lets you control: +The preferences file lets you override: -- **Notification defaults**: Set your preferred notification channels and timing -- **Message templates**: Customize how suggestion summaries appear in notifications -- **Tone and style**: Adjust the voice and formality of notification messages -- **Delivery preferences**: Configure which events trigger notifications and how they're formatted +- **When to notify**: Control which events trigger notifications and when to skip them +- **Delivery channels**: Set preferences for Slack vs. GitHub notifications +- **Message style**: Adjust the tone and context included in notification messages ### Example Customizations Here are some common ways teams customize their notifications: -**Change the notification tone:** +**Change notification timing:** ``` -Use a casual, friendly tone in all notification messages. -Avoid formal language like "please be advised" or "for your review." +Only send notifications for suggestions that modify more than one file. +Skip notifications for automated triggers that don't yield documentation updates. ``` -**Customize message content:** +**Adjust delivery preferences:** ``` -Always include the number of files changed in the notification summary. -Mention the trigger source (PR, Slack message, etc.) prominently. +Always reply in the originating Slack thread when the trigger came from Slack. +Use GitHub comments when reviewers are already engaged with the source PR. ``` -**Set delivery preferences:** +**Customize message style:** ``` -Only send notifications for suggestions that modify more than one file. -Include diff file attachments for all Slack notifications. +Use a casual, friendly tone in all notification messages. +Include enough context that someone new to the thread can understand why Promptless is posting. ``` ## Slack Notification Features