Skip to content

For the complete documentation index, see llms.txt.

Review and edit Promptless PRs

Promptless opens a docs PR for a suggestion when you publish it, or when a publishing policy opens one automatically. A docs PR is a GitHub pull request or a GitLab merge request in your documentation repository. Review the suggestion in the Promptless dashboard to check its evidence and rendered changes. Then steer the docs PR with comments and reviews, the same way you review code. Promptless fixes quality issues in its docs PRs, such as linter failures, Vale warnings, and broken links, so your feedback can focus on the content.

Every PR that Promptless opens links to its suggestion in the dashboard, at the top of the PR description. The suggestion holds what you need to judge a change before you merge it. Suggestions that don’t have a PR yet open from the review queue.

  • Evidence: Citations tie each change to the files, PRs, and commits Promptless relied on. The research breakdown lists everything Promptless read before drafting, such as source files and Slack threads.
  • History: A timeline records each commit to the suggestion’s branch with its author, time, and changed files. It shows what Promptless and your teammates changed, and when.
  • Collaboration: Assignees, labels, and overall comments let your team coordinate on the suggestion.

From the suggestion, you can edit the changes yourself, ask Promptless for changes, publish the suggestion as a PR or MR, or close it.

Suggestion detail view with a three-tab bar showing the active Review Suggestion tab with the suggested file diff, the Triggers & Analysis tab, and the History & Collaboration tab

Review a change as readers see it, not only as a diff. Markdown and MDX files render with added and removed content highlighted, so you can check headings, lists, tables, and code blocks in context.

Changed images appear as before-and-after versions side by side. SVG files render as images, and their markup diff is also available. You can reject a single image change to restore its previous version while keeping the rest of the suggestion. Image previews cover PNG, JPEG, GIF, BMP, WebP, AVIF, and SVG files.

When you rename a suggestion that has an open or draft PR on GitHub, Promptless renames the PR to match. The new title takes effect only after GitHub accepts it, so the suggestion and the PR keep the same title. Renaming the PR on GitHub updates the suggestion the next time you open it. Renaming changes only the title, not the branch or its commits.

Promptless posts one comment on the docs PR for each changed file. On GitLab, the comment is a discussion. Under a Sources heading, the comment links each source Promptless used and states the claim that source supports.

  • Promptless updates the comment when the suggestion changes.
  • Promptless resolves the comment after it posts it. Repositories that require resolved threads can still merge.
  • Promptless leaves a comment alone after you reply to it or reopen it.
  • This behavior is always on. There is no setting.

When several suggestions are ready to publish, select them in the suggestions list and open their PRs in one batch. You can select suggestions one at a time, as a range, or as everything that matches your current filters. Promptless skips suggestions that are closed, have no changed files, or already have an open or draft PR. Before it starts, it confirms how many PRs it opens. You can retry any PR that fails to open.

To have Promptless act on a comment or review, mention @promptless (or @promptless-for-oss) anywhere in it, or start a line with /promptless. Both forms work on GitHub pull requests and GitLab merge requests, whatever your organization’s comment setting. A mention from an automated account, such as a continuous integration (CI) or service account, counts the same as one from a teammate.

Whether comments need a mention depends on the PR and MR Comment Trigger Mode setting in Settings → Organization. Changing it requires the Admin role.

  • Listen to all comments (default for new organizations): Promptless acts on comments from people on its docs PRs. It also acts on comments on any other open PR or MR it commented on or reviewed.
  • Require a mention (default for existing organizations): Comments need a mention, except replies in a review thread or discussion where Promptless already commented.

Promptless skips comments meant only for someone else, and may skip comments from automated accounts unless they mention it. To keep Promptless from acting on a comment, start it with aside or /aside.

Leave feedback on the docs PR in GitHub or GitLab. Promptless reads all previous comments on the PR to understand the context. An instruction can be as short as “Same here” or “Apply this change to the other section too.”

Leave a comment on a specific line or section of the docs PR for targeted feedback.

  • With Listen to all comments selected, leave the comment. Promptless processes it automatically.
  • With Require a mention selected, tag @promptless in the comment. The mention doesn’t appear in autocomplete, but Promptless still sees it.
A line comment on a GitHub docs PR that tags @Promptless and asks for an intro paragraph summarizing the section

To give several pieces of feedback at once on GitHub, submit a pull request review. Promptless handles all of the review’s comments together after you submit it.

  • With Listen to all comments selected, submit the review. Promptless processes it automatically.
  • With Require a mention selected, tag @promptless in the review summary.

Comments like these work on a docs PR, and in the dashboard:

Kind of changeExample comment
Content updatePlease add a section about error handling for this API endpoint
Content updateAdd a note that this feature requires admin permissions
Structural changeMove this section to the beginning of the page for better flow
Structural changeSplit this into two separate sections: "Basic Usage" and "Advanced Configuration"
Technical correctionThe API endpoint should be /v2/users, not /v1/users
Technical correctionInclude the response status codes for each endpoint
Style and formattingFormat this as a code block instead of inline code
Style and formattingUse a callout box to highlight this important warning

To have Promptless apply a rule to every future suggestion, phrase it as a standing rule. For example: “Always include the response status codes for each endpoint.” See Teach conventions with feedback.