diff --git a/fern/docs/core-concepts/triggers.md b/fern/docs/core-concepts/triggers.md index af8d67b..de71715 100644 --- a/fern/docs/core-concepts/triggers.md +++ b/fern/docs/core-concepts/triggers.md @@ -41,6 +41,7 @@ Slack integration enables documentation updates directly from your team conversa **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 when threads go quiet #### Image Processing in Slack Threads diff --git a/fern/docs/faq.mdx b/fern/docs/faq.mdx index 9913b9b..c15f2b8 100644 --- a/fern/docs/faq.mdx +++ b/fern/docs/faq.mdx @@ -20,9 +20,11 @@ For a complete list, see our [Integrations overview](/docs/integrations). ### Does Promptless monitor my Slack channels? -No, Promptless does not monitor or automatically read messages in Slack channels. It only accesses Slack content when you explicitly trigger it by tagging @Promptless or using the "Update Docs" message action. The broader permissions requested during Slack app installation are designed to support potential future opt-in features, but currently Promptless operates on an explicit trigger-only model. +By default, no. Promptless only accesses Slack content when you explicitly trigger it by tagging @Promptless or using the "Update Docs" message action. -For more details, see our [Slack Integration documentation](/docs/integrations/slack-integration). +However, you can optionally enable **passive listening** for specific channels. When enabled, Promptless will monitor only the channels you explicitly select in your project configuration. This is completely opt-in - you choose which channels to monitor and can add or remove channels at any time. + +For more details, see our [Slack Integration documentation](/docs/integrations/slack-integration) and [Working with Slack](/docs/features/slack-interactions#4-passive-channel-listening). ### How does Promptless handle my data? diff --git a/fern/docs/features/slack-interactions.mdx b/fern/docs/features/slack-interactions.mdx index b3d3434..b5dda3b 100644 --- a/fern/docs/features/slack-interactions.mdx +++ b/fern/docs/features/slack-interactions.mdx @@ -1,13 +1,13 @@ --- title: Working with Slack -description: Learn how to use Promptless directly in Slack through message actions, DMs, and channel mentions +description: Learn how to use Promptless directly in Slack through message actions, DMs, channel mentions, and passive listening --- Make sure you have the [Slack integration](/docs/integrations/slack-integration) set up before using these features. -## Three Ways to Interact +## Four Ways to Interact ### 1. Message Actions @@ -81,4 +81,44 @@ Send direct messages to Promptless for private documentation requests or when yo +### 4. Passive Channel Listening + +Have Promptless automatically monitor specific Slack channels and create documentation updates without requiring @mentions or message actions. This is ideal for documentation-focused or support channels where discussions frequently reveal documentation needs. + +When passive listening is enabled, Promptless monitors all messages in your selected channels and automatically creates documentation suggestions when threads become inactive. + + + + Go to the [projects page](https://app.gopromptless.ai/projects) and click the edit button on your Slack trigger project. + + + + Check the box for "Listen for all messages in specific channels" under the trigger configuration. + + + Project configuration showing passive listening checkbox and channel selection + + + + + Choose which channels Promptless should monitor. You can select multiple channels. + + + + Click "Save" to activate passive listening for the selected channels. + + + + + No. When passive listening is enabled, Promptless waits for a thread to go quiet before analyzing it. This prevents creating redundant suggestions as conversations evolve. + + If new messages are added to a thread that Promptless has already processed, Promptless can update its existing suggestion rather than creating a duplicate. This means even if there are multiple triggers for the same thread, you'll see updates to a single suggestion rather than a flood of separate suggestions. + + **Tip**: If you @mention Promptless in a thread that's being passively monitored, it will trigger immediately rather than waiting for the thread to go quiet. + + + + Passive listening is completely opt-in. Promptless only monitors channels you explicitly select in your project configuration. You can add or remove channels at any time. + + Need help with Slack interactions? Contact us at [help@gopromptless.ai](mailto:help@gopromptless.ai). \ No newline at end of file diff --git a/fern/docs/integrations/slack.mdx b/fern/docs/integrations/slack.mdx index 3965b0a..f519971 100644 --- a/fern/docs/integrations/slack.mdx +++ b/fern/docs/integrations/slack.mdx @@ -42,8 +42,20 @@ Below is an example of a project that is set up to trigger from Slack. Once the Project is created, you will be able to trigger Promptless by writing @Promptless in a Slack channel, or by clicking Slack "Update Docs" message action on any thread. When you perform either of these actions, Promptless will pull the entire thread it was tagged in, and identify the right documentation updates based on the contents of that thread. +### Optional: Passive Channel Listening + +You can optionally enable passive listening for specific channels. When enabled, Promptless will automatically monitor conversations in your selected channels and create documentation suggestions when threads become inactive. + +To enable passive listening: +1. Edit your Slack trigger project +2. Check the box for "Listen for all messages in specific channels" +3. Select which channels to monitor +4. Save your configuration + +Passive listening is completely opt-in and only applies to channels you explicitly select. For more details, see [Working with Slack](/docs/features/slack-interactions#4-passive-channel-listening). + - Promptless only reads Slack content when you explicitly trigger it by tagging @Promptless or using the "Update Docs" message action. It does not monitor, scan, or automatically read messages in any channels. Promptless cannot access private channels unless it has been specifically invited to those channels. + By default, Promptless only reads Slack content when you explicitly trigger it by tagging @Promptless or using the "Update Docs" message action. If you enable passive listening, Promptless will monitor only the specific channels you select in your project configuration. Promptless cannot access private channels unless it has been specifically invited to those channels. ## Image Processing in Slack Threads @@ -94,11 +106,16 @@ This feature requires additional Slack permissions to access images in threads. ### What Promptless Actually Does -Promptless operates on an **explicit trigger model** with Slack: +By default, Promptless operates on an **explicit trigger model** with Slack: - **Only reads content when triggered**: Promptless only accesses Slack messages when you explicitly tag @Promptless or use the "Update Docs" message action - **Thread-based processing**: When triggered, Promptless reads the entire thread to understand context, but only for that specific thread -- **No background monitoring**: Promptless does not scan, monitor, or automatically read messages in any channels +- **No background monitoring by default**: Unless you enable passive listening for specific channels, Promptless does not scan, monitor, or automatically read messages in any channels + +If you enable **passive channel listening** (optional): +- **Selective monitoring**: Promptless will monitor only the specific channels you explicitly select in your project configuration +- **Automatic suggestions**: When threads become inactive, Promptless analyzes the conversation and creates documentation suggestions when appropriate +- **Full control**: You can add or remove channels from passive listening at any time ### Why Broader Permissions Are Requested