-
Notifications
You must be signed in to change notification settings - Fork 4
content: Launch post — Suggestion Citations Now Post Inline on GitLab Merge Requests #869
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
frances720
wants to merge
2
commits into
main
Choose a base branch
from
articles/2026-08-17-gitlab-inline-citation-comments
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 1 commit
Commits
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
49 changes: 49 additions & 0 deletions
49
src/content/blog/product-updates/gitlab-inline-citation-comments.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,49 @@ | ||
| --- | ||
| title: 'Suggestion Citations Now Post Inline on GitLab Merge Requests' | ||
| subtitle: Published August 2026 | ||
| description: >- | ||
| When Promptless opens a merge request on GitLab, suggestion citations now post as diff-positioned discussion threads on the MR itself, not only in the Promptless dashboard. | ||
| date: '2026-08-11T00:00:00.000Z' | ||
| author: Frances | ||
| tag: Product Updates | ||
| section: Featured | ||
| hidden: false | ||
| --- | ||
| import BlogNewsletterCTA from '@components/site/BlogNewsletterCTA.astro'; | ||
| import BlogRequestDemo from '@components/site/BlogRequestDemo.astro'; | ||
|
|
||
| When Promptless opens or updates a merge request on GitLab, the suggestion's citations now post as diff-positioned discussion threads on the MR itself. Reviewers can see why Promptless made each change without leaving GitLab. | ||
|
|
||
| ## The problem | ||
|
|
||
| Every Promptless suggestion includes citations: references to the source material that informed specific changes. A PR body that describes a new behavior, a knowledge base article that explains an existing pattern, a spec document that defines expected output. These appear in the Promptless dashboard next to the relevant changes in the suggestion viewer. | ||
|
|
||
| For GitLab teams, this created a split review workflow. A reviewer opening a Promptless docs MR in GitLab could see the changed lines but not the reasoning behind them. To find the citations, they had to leave GitLab, open the Promptless dashboard, locate the suggestion, and read the citations panel there. Then go back to GitLab to continue the review. | ||
|
|
||
| The context-switch compounds on teams where multiple people review the same suggestion. Each reviewer independently had to decide whether to check the dashboard or just approve based on the diff alone. Citation context that would help a reviewer make a better decision wasn't reaching them where they worked. | ||
|
|
||
| GitHub PRs have had inline citations for a while. GitLab merge requests did not. | ||
|
|
||
| ## What it does now | ||
|
|
||
| When Promptless opens or updates a GitLab MR, citations post as discussion threads on the MR, anchored to the lines in the diff they support. The threads appear in the GitLab discussion panel alongside any review comments from human reviewers. A reviewer who wants to understand why a specific paragraph was changed can see the citation for it in context, without switching to a separate tool. | ||
|
|
||
| When a citation can't be anchored to the diff, Promptless falls back to an unanchored thread on the MR that names the file and line. This covers cases where the source material informed a change without mapping to a specific line in the changed output. | ||
|
|
||
| The Promptless dashboard continues to show citations in the suggestion viewer. The inline MR comments are additive. | ||
|
|
||
| <BlogNewsletterCTA /> | ||
|
|
||
| ## Who benefits most | ||
|
|
||
| Teams using GitLab who review Promptless suggestions inside GitLab rather than inside the Promptless dashboard. The benefit increases with team size: when multiple reviewers look at the same suggestion, each now has citation context in GitLab rather than relying on one person to check the dashboard and relay the reasoning. | ||
|
|
||
| This is especially relevant for documentation teams that use GitLab as their primary review surface. When a Promptless suggestion touches a section that isn't immediately obvious from the diff alone, the citations do the explanation work inside the tool where the review is happening. | ||
|
|
||
| ## How to use it | ||
|
|
||
| Nothing to configure. Promptless posts citations on GitLab MRs automatically as long as `auto_create_pr` is enabled in your [publishing policies](/docs/reference/configuration-reference#policies). If you're already using Promptless with GitLab doc collections, citations will appear on new MRs going forward. | ||
|
|
||
| See [GitLab projects](/docs/connect/doc-locations/gitlab-projects#automatic-merge-request-creation) for more on how Promptless manages GitLab merge requests. | ||
|
|
||
| <BlogRequestDemo /> | ||
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.
Correctness (verified against source PR #4514) — please fix before publish.
auto_create_pris not the gate for citation posting, so "as long asauto_create_pris enabled" is inaccurate and could mislead readers.In the source, citation delivery is gated on the docs MR existing with its URL recorded (plus a resolved SHA and a GitLab/GitHub collection) — not on any policy flag.
auto_create_pronly controls whether Promptless opens the MR automatically. A team that runs withauto_create_proff but opens MRs another way (the dashboard "Create PR" button, Slack, or an explicit request) still gets inline citations — the current wording tells them the opposite.Separately, same sentence: "citations will appear" uses future-tense "will" for product behavior, which the client style guide asks us to avoid — use present tense.
Suggested rewrite that fixes both:
(That rewrite drops the
auto_create_pr/publishing-policies reference since it isn't the gate. If you'd like to keep a pointer to how MRs get created, the GitLab projects link you already cite at the end covers it.)