Use the web interface
Suggestions list
Section titled “Suggestions list”The suggestions list shows all documentation suggestions awaiting your review. Each suggestion card includes chips that help you identify key details at a glance:
- Docs target: A chip with a document icon shows which doc collection the suggestion targets. Hover over the chip to see the full repository path, or click it to filter the list to suggestions targeting that collection—especially useful if your organization has multiple doc collections.
- Archiving soon: Suggestions approaching auto-archive display an orange chip. Hover over it for details about auto-archive behavior. Viewing or editing a suggestion resets the timer.
By default, suggestions are automatically archived after 30 days of inactivity. Viewing or editing a suggestion resets the timer, so anything you’re actively reviewing stays in the queue. If your team wants a different window—or wants to keep suggestions open indefinitely—an admin can change or disable archiving per doc collection with the archiving policy. See the Configuration reference for the enabled and stale_after_days fields. If a suggestion is auto-archived before you can review it, we can restore it for you.
Suggestion overview
Section titled “Suggestion overview”Each suggestion includes a title and description that explains what changes are being made and why.
Edit the title
Section titled “Edit the title”You can rename a suggestion from its detail page. Click the pencil next to the title, type a new name, and press Enter or click the checkmark to save. Press Escape or click the X to cancel. Titles can’t be empty.
When a suggestion already has an open or draft documentation PR, GitHub is the source of truth for the title. Saving pushes the rename to the GitHub PR title first, and Promptless keeps the new title only once GitHub accepts it, so your dashboard and the PR stay in sync. Only the PR title changes—your branch and commits are untouched. If the GitHub update fails, Promptless leaves the title unchanged and shows a retryable error. If you rename the PR on GitHub instead, opening the suggestion in the dashboard pulls the current PR title back in.
For a suggestion with no open PR, Promptless saves the edit locally.
Markdown preview
Section titled “Markdown preview”Preview how Markdown and MDX files will render before publishing. Click Preview Markdown on any .md, .mdx, or .markdown file to open a preview modal with diff highlighting—added content appears with a green background and left rail, removed content shows red. This helps you review formatting, headings, lists, tables, and code blocks in context without switching between raw diff and published views.
Image preview
Section titled “Image preview”When a suggestion changes an image or screenshot, the suggestion viewer shows a side-by-side before-and-after preview so you can compare the old and new versions directly. Both images render together for visual comparison—there’s no overlay, slider, or automated pixel-diff.
- Added images show only the new version; deleted images show only the previous version.
- You can open an image at full size to inspect it more closely.
- Previews render for common image formats: PNG, JPEG, GIF, BMP, WebP, and AVIF. Other files, including SVGs, fall back to the standard diff, and unsupported or very large files show a message instead of an inline preview.
- Image-only suggestions get the same status as any other suggestion, so you can apply and publish them the same way.
- Rejecting an individual image restores the previous version rather than deleting the file.
The commit timeline
Section titled “The commit timeline”The commit timeline lists the commits on a suggestion’s branch, so you can see the work behind it. It also includes the automatic sync/merge commits Promptless creates when it merges the base branch into the suggestion branch. A sync/merge row can report a large file count because it reflects content pulled in from the base branch, not changes the suggestion itself proposes.
When there’s nothing to review
Section titled “When there’s nothing to review”When a suggestion’s branch matches its base branch, the viewer shows an explanatory panel that reads “No changes against” plus the base branch name.
This normally means the changes already landed on the base branch, or a sync merge replaced them. If the branch has no commits at all, the panel instead says the branch has no content that differs from the base.
From here you can select Request Changes to ask Promptless for a different approach, or Close Suggestion to end the suggestion with feedback. If you think the empty result is an error, contact support. The panel also shows the branch name with a View branch link to the branch on GitHub or GitLab when available, and renders the commit timeline inline below it.
Provide feedback
Section titled “Provide feedback”Promptless offers several ways to provide feedback on suggestions. Learn about all available feedback methods in the Teaching conventions with feedback guide.
Bulk opening pull requests
Section titled “Bulk opening pull requests”When you have multiple suggestions ready to publish, you can open PRs for all of them at once.
- Click Select in the suggestions list toolbar to enter select mode.
- Check the suggestions you want to include. Use Select all matching to select all suggestions that match your current filters.
- Click Open N PRs in the floating action bar at the bottom of the screen.
- Review the confirmation dialog—it shows how many PRs will be opened and how many will be skipped.
- Click Confirm to start opening PRs. A progress banner tracks each suggestion as it completes.
Suggestions that will be skipped:
- Suggestions that already have an open or draft PR
- Suggestions with no content (no files changed)
- Closed suggestions
If any requests fail, use Retry failed to retry them. Press Esc at any time to exit select mode.
Deep Analysis
Section titled “Deep Analysis”Deep analysis is one of three options in the New Task composer’s Mode chip, alongside Fast and Default. Default is preselected; set Mode to Deep analysis to switch to it.
- Fast: Makes a single direct pass—best for typos and small wording fixes.
- Default: Runs the full writer workflow—best for most docs changes.
- Deep analysis: Runs many agents across many PRs—best for audits and migrations.
Deep Analysis handles large, complex documentation requests that may take several hours to complete and produce multiple suggestions. The composer’s Use a template rail offers starter prompts for common request shapes like refactoring a section of docs, auditing for consistency, or writing docs from scratch.
For details on when to use Deep Analysis and how to submit requests, see the Deep Analysis guide.
Screenshot Updates
Section titled “Screenshot Updates”Screenshot Updates is a tab in the dashboard’s left sidebar. It shows an org-wide gallery of every screenshot attached to an open suggestion—any suggestion that isn’t closed. The nav item carries a count badge with the number of screenshots on open suggestions, and hides the badge when that count is zero.
Screenshots are grouped by doc collection, under a collection header showing the collection name and a count chip showing how many screenshots that collection has. Screenshots whose suggestion isn’t tied to a doc collection fall under an Uncategorized group. The newest screenshots come first, both within a group and across groups, and each screenshot gets its own card—so a suggestion with five screenshots produces five cards.
- Each card shows the thumbnail by default; the suggestion title and the captured date reveal when you hover or focus the card.
- Click a card to open that screenshot’s suggestion, scrolling to and briefly highlighting that specific image, where you can compare it against the previous version and reject it if needed, or publish the suggestion to accept it (see Image preview).
- When a collection group holds more screenshots than fit, it clips with a fade and adds a Show more toggle that reveals the rest, along with a chevron in its header that collapses the group; a group that already fits shows none of these.
When no open suggestion has any screenshots, the tab shows an empty state noting there are none right now. Screenshots often appear here after Promptless Capture regenerates them following a UI change.
Triggers page
Section titled “Triggers page”The Triggers page shows every event that triggered Promptless over the last 30 days. Each trigger appears as a card with a timeline of what it produced, read from top to bottom, so you can see a trigger’s outcome at a glance without opening it:
- Received: The event that fired—such as a GitHub PR or a Slack message—and when it landed.
- Suggestion created, Suggestion updated, or Suggestion closed: A row for each documentation suggestion the trigger acted on. Suggestion closed appears when that trigger’s Promptless run closed the suggestion itself, whatever state its pull request is in. Each row carries a chip showing where that suggestion’s pull request stands: PR Open, Published (the PR merged), or Closed (the PR was closed without merging). Click a suggestion to open it. When a run finishes without producing a suggestion, the timeline notes No suggestion created instead.
- Trigger completed: When Promptless finished handling the trigger.
While a trigger is still being processed, its card shows a Processing indicator in place of the completion.
Filter and search
Section titled “Filter and search”Use the search box to find triggers by PR info, Slack thread topic, task name, or other summary text—including events older than 30 days. The type and suggestion-activity filters help narrow results further.
The From and To date fields filter by a specific date range. Date filtering searches your full trigger history, not just the default 30-day window. Clear the dates to return to the default view.
Group triggers
Section titled “Group triggers”The Group by control organizes the trigger list:
- None: Flat list, newest first (default)
- Event source: Groups triggers by platform (GitHub, Slack, etc.) with the most recently active source first
- Date: Groups triggers by day with headers like “Today”, “Yesterday”, or the calendar date
Click any group header to collapse it—a count pill shows how many triggers are hidden. Click again to expand.
Click any trigger to see full details, including what research Promptless did and why it created (or skipped) documentation updates.
Research breakdown
Section titled “Research breakdown”When you open a trigger—from the Triggers page, or from a suggestion’s Triggers & Analysis tab—Promptless shows a breakdown of the research it did before drafting (or skipping) documentation. A summary line like “Promptless reviewed: 10 files, 2 knowledge base files, 3 searches” expands into a detailed list of what the agent read and searched.
The detailed list shows the agent’s work in roughly the order it happened, so you can follow the run as it unfolded. Along the way you see a few kinds of entries:
- Files: source and documentation files the agent opened, shown as clean repository-relative paths.
- Knowledge base files: reads from your Knowledge Base—such as contribution guidelines or style rules—shown inline at the point in the sequence where the agent consulted them. Each one is labeled “Read from knowledge base” and links to that file in the Agent Knowledge Base editor in a new tab.
- Searches: content and filename searches the agent ran. Each search includes a chip showing where it ran: a branded chip for your doc collection, or a sandbox chip when the agent searched its own working directory.
- Webpages and Slack: external pages the agent fetched and Slack threads it read.
When Promptless delegates part of its research to a specialized subagent, that work appears as an indented branch labeled “Delegated research to <subagent-type>”. A tool-call count appears alongside it as ”· N tool calls”. The count stands in for that subagent’s work—much of it shell commands, which don’t each produce their own row. Older suggestions, created before delegation tracking existed, render flat, without a delegation branch.
If the agent used any of your own skills, a “Used N of your skills” callout appears next to the summary, so you can see when Promptless applied a workflow you authored. When Promptless delegates research, a “N research agents” callout sits alongside the summary.
Need help with the web interface? Contact us at help@gopromptless.ai.