Skip to content

docs: Document configurable GitHub PR comment trigger modes #238

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.

Sign up for GitHub

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

Merged
prithvi2206 merged 1 commit into from
Feb 12, 2026
Merged

docs: Document configurable GitHub PR comment trigger modes #238

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 18 additions & 6 deletions fern/docs/features/github-pr-comments.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,18 @@ description: Learn how to provide follow-up instructions through GitHub PR comme

After Promptless opens a docs PR, you can provide follow-on instructions directly through GitHub comments. Promptless automatically handles quality issues (like linter failures, Vale warnings, or broken links) that arise in documentation PRs, so manual feedback can focus on content improvements rather than technical fixes.

## Comment trigger modes
Copy link
Contributor Author

@promptless promptless bot Feb 11, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Citation: Documents the new configurable GitHub PR comment trigger modes from PR #1984. Key implementation in server/backend/integrations/github/routes.py (implements get_pr_comment_mode(), is_aside_prefix(), and mode-based triggering), server/utils/config.py (defines GitHubPrCommentMode enum with mention_only and listen_all_with_aside values), and promptless-dashboard/src/app/settings/OrgSettingsTab.tsx (UI controls showing the two options and aside//aside opt-out behavior).
View source


Configure how Promptless responds to comments on documentation PRs:

**Listen to all comments** (default for new organizations): Promptless processes all human comments on documentation PRs automatically. To have Promptless ignore a specific comment, start it with `aside` or `/aside`.

**Require @promptless mentions** (default for existing organizations): Promptless only responds when you tag @promptless in a comment.

<Info>
Change this setting anytime in [Settings → Org Settings](https://app.gopromptless.ai/settings).
</Info>

## Reviewing in the dashboard

Every PR that Promptless opens includes a dashboard link at the top of the description for additional context.
Expand All @@ -23,25 +35,25 @@ Use the dashboard to verify updates or understand the background behind changes.

Leave individual comments on specific lines or sections of the documentation PR for targeted feedback.

Tag Promptless (@Promptless) in the comment (Note: It won't show up in auto-complete), write your instruction, and click "Add single comment" to submit your instruction to Promptless.
If your organization uses **Listen to all comments** mode, just leave your comment—Promptless will process it automatically. In **Require @promptless mentions** mode, tag @promptless in the comment (it won't show up in auto-complete, but Promptless will still see it).

When you tag Promptless, it automatically reads all previous comments in the PR to understand the full context. This means that your instructions can be as simple as "Same here" or "Apply this change to the other section too," and Promptless will understand what you mean.
Promptless automatically reads all previous comments in the PR to understand the full context. This means your instructions can be as simple as "Same here" or "Apply this change to the other section too."

### 2. PR reviews

Start a review to provide multiple pieces of feedback that Promptless can handle all at once.

<Steps>
<Step title="Start a Review">
You can either click "Review changes" to begin a formal review process, or when adding an in-line comment, select the "Start a review" option instead of the "Add single comment" option.
Click "Review changes" to begin a formal review process, or select "Start a review" when adding an in-line comment.
</Step>

<Step title="Add Multiple Comments">
Continue adding comments as part of the review. You don't have to tag Promptless in any of them.
Continue adding comments as part of the review.
</Step>

<Step title="Include General Feedback">
After you're done reviewing, click on "Finish your review", and in the text box, tag Promptless (@Promptless). And then Promptless will address all your review feedback at once.
<Step title="Submit Your Review">
Click "Finish your review" and submit. In **Listen to all comments** mode, Promptless processes the review automatically. In **Require @promptless mentions** mode, tag @promptless in the review summary.
</Step>
</Steps>

Expand Down