docs: Document commit trigger approaches and private channel access #222
Conversation
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
promptless
bot
requested review from
adit-chandra,
frances720,
mattlink and
prithvi2206
as code owners
![promptless[bot]](https://avatars.githubusercontent.com/in/979718?s=60&v=4){kind=small}
| 3. **Relevance Assessment**: Promptless determines if the changes require documentation updates | ||
| 4. **Suggestion Creation**: If relevant, Promptless creates documentation suggestions | ||
|
|
||
| ## Commit Triggers vs. Pull Request Triggers |
Contributor
Author
There was a problem hiding this comment.
Citation: Based on prithvi's explanation of the two approaches: (1) commits + PRs for getting PR comments plus updated suggestions after merge, or (2) commits only for teams who find PR triggers too noisy. When using commits only, you won't get PR comments so a Slack notification channel is recommended.
View source
| 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 in your project settings, Promptless will monitor only the specific channels you select. 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 in your project settings, Promptless will monitor only the specific channels you select. | ||
|
|
||
| ### Adding Promptless to Private Channels |
Contributor
Author
There was a problem hiding this comment.
Citation: Based on prithvi's advice that if a notification channel is private, you need to add Promptless to it first—the easiest way is to tag @promptless in that channel.
View source
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Open this suggestion in Promptless to view citations and reasoning process
Documents two approaches for using GitHub commit triggers and explains how to configure Slack notification channels.
Changes to GitHub Commits trigger page:
Changes to Slack integration page:
@Promptlessin the channelTrigger Events
Internal discussion about verifying documentation coverage for customer questions and identifying which article sections to reference.
Promptless Research (1 Slack conversation)
Agent Response
Help us improve Promptless — If this suggestion missed the mark, please share quick feedback.
If you want Promptless to make further changes on this PR, feel free to leave a comment tagging Promptless (It won't show up in the user drop down but Promptless will get it!)