-
Notifications
You must be signed in to change notification settings - Fork 3
docs: Document notification customization via Long-Term Context #315
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
promptless
wants to merge
5
commits into
main
Choose a base branch
from
promptless/notification-customization-via-ltc
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
1dbfc1d
Add documentation for customizing notifications via Long-Term Context
promptless[bot] 3d6cfac
Update button name from 'Open PR' to 'Create PR'
promptless[bot] f64a268
Merge branch 'main' into promptless/notification-customization-via-ltc
3e29553
{"committer_name": "user_2lkm8iLz0zNLtpxfPLNuEme54nw", "committer_typ…
309c53a
Update notification preferences file path and documentation
promptless[bot] File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
73 changes: 73 additions & 0 deletions
73
src/content/docs/docs/configuring-promptless/customizing-notifications.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. | ||
|
|
||
| <Note> | ||
| 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. | ||
| </Note> | ||
|
|
||
| ### 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 | ||
|
|
||
| <Tip> | ||
| 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. | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. PR #2681 changed the button label from "Open PR" to "Create PR" |
||
| </Tip> | ||
|
|
||
| ## 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. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
PR #2611 introduced customer-editable notification customization via Long-Term Context. Customers can customize notification defaults, templates, tone, and delivery preferences by editing doc_workflow/notification_skill.md in their organization's LTC.
Source: https://github.com/Promptless/promptless/pull/2611