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..14fee234 --- /dev/null +++ b/src/content/docs/docs/configuring-promptless/customizing-notifications.mdx @@ -0,0 +1,73 @@ +--- +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 Preferences File + +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 preferences file lets you override: + +- **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 notification timing:** +``` +Only send notifications for suggestions that modify more than one file. +Skip notifications for automated triggers that don't yield documentation updates. +``` + +**Adjust delivery preferences:** +``` +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. +``` + +**Customize message style:** +``` +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 + +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 "Create 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 3b8b7aeb..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" }, { @@ -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" } ] },