Skip to content

Commit c989ddf

Browse files
docs: Document automated quality assurance for documentation PRs (#86)
* Documentation updates from Promptless * Sync documentation updates from Promptless agent * Sync documentation updates from Promptless agent * Sync documentation updates from Promptless agent * Sync documentation updates from Promptless agent * Sync documentation updates from Promptless agent * Sync documentation updates from Promptless agent * Sync documentation updates from Promptless agent * Update fern/docs/changelogs/2025-09.md --------- Co-authored-by: promptless[bot] <179508745+promptless[bot]@users.noreply.github.com> Co-authored-by: frances720 <[email protected]>
1 parent c2e46ba commit c989ddf

File tree

3 files changed

+32
-4
lines changed

3 files changed

+32
-4
lines changed

fern/docs/changelogs/2025-09.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,28 @@ title: September 2025
66

77
* **Enhanced Slack Context Understanding:** Promptless agents now analyze full Slack conversations instead of individual messages when creating documentation updates. When you share a Slack message URL, Promptless can now see the surrounding discussion to better understand context, decisions, and team conversations. This leads to more accurate and comprehensive documentation that captures the complete story behind your team's discussions.
88

9+
* **Enhanced GitHub PR Comment Context Awareness:** When you tag Promptless in individual GitHub PR comments, it now automatically reads all previous comments in the PR to understand the full context. This means you can use simple instructions like "Same here" or "Apply this change to the other section too" without having to repeat the full context. Previously, single comments couldn't reference other comments, requiring you to spell out instructions completely or use PR reviews for contextual feedback. This improvement makes it faster and easier to provide follow-on instructions directly in PR comment threads.
10+
911
* **GitBook Platform Support:** Promptless now supports GitBook as a first-class documentation hosting provider. Teams using GitBook can connect their repositories to automatically update their GitBook documentation when code changes are made. This expands Promptless support to include GitBook alongside existing platforms like Fern, Mintlify, and Docusaurus, making it easy for GitBook users to maintain up-to-date documentation through automated workflows.
12+
13+
* **Improved Jira Context Integration:** Promptless now more reliably fetches Jira ticket information when issues are mentioned in pull requests or trigger events. When a Jira ticket ID appears in a PR description or comments, Promptless consistently retrieves the full ticket context including descriptions, comments, and related issues. This ensures documentation updates have complete context from your Jira workflow, leading to more accurate and comprehensive documentation that reflects the full scope of your work.
14+
15+
* **Automated CI Check and Build Issue Resolution for Documentation PRs:** Promptless now automatically detects and fixes quality issues in documentation pull requests. When linters fail, Vale rules trigger warnings, or documentation hosting providers report broken links or build errors, Promptless automatically analyzes the issues and pushes fixes to the PR branch. This eliminates manual intervention for common quality problems and maintains documentation standards without interrupting your workflow. Quality issues are resolved seamlessly in the background, allowing teams to focus on content rather than troubleshooting technical problems.
16+
17+
* **Smart Draft State Management for Documentation PRs:** Documentation PRs now open as drafts when the source code PR hasn't merged yet, then automatically switch to "Ready for Review" once the source PR merges. This means your team only reviews documentation changes after the underlying code is finalized.
18+
19+
<Frame>
20+
<img src="https://promptless-customer-doc-assets.s3.amazonaws.com/docs-images/org_2lvkgU9erOFxYhtEVVC0ymPrPdF/draft-pr-warning-dialog-1759347818.png" alt="Warning dialog showing that the documentation PR will be opened as a draft since the trigger PR is not merged yet" />
21+
</Frame>
22+
23+
<Frame>
24+
<img src="https://promptless-customer-doc-assets.s3.amazonaws.com/docs-images/org_2lvkgU9erOFxYhtEVVC0ymPrPdF/draft-pr-github-status-1759347818.png" alt="GitHub pull request showing draft status for Promptless documentation PR" />
25+
</Frame>
26+
27+
* **Improved Dashboard Synchronization for Follow-on Suggestions:** The dashboard now immediately reflects changes when you make follow-on suggestions to documentation. Previously, there could be delays where the dashboard wouldn't show your latest follow-on edits right away. This improvement ensures that when you refine suggestions through follow-on instructions, the dashboard instantly updates to show your changes, providing better real-time visibility into your documentation workflow.
28+
29+
* **PR Open Status Filter:** You can now filter for suggestions published as pull requests directly from the status dropdown. Previously, you had to manually type `is:pr_open` into the search bar. The "PR Open" option appears alongside "Ready," "Published," and "Rejected."
30+
31+
<Frame>
32+
<img src="https://promptless-customer-doc-assets.s3.amazonaws.com/docs-images/org_2lvkgU9erOFxYhtEVVC0ymPrPdF/pr-open-filter-dropdown-1759253451.png" alt="PR Open filter option in the suggestions dashboard status dropdown" />
33+
</Frame>

fern/docs/features/github-pr-comments.mdx

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Interacting with Promptless PRs
33
description: Learn how to provide follow-up instructions through GitHub PR comments and reviews after your documentation PR is opened
44
---
55

6-
After Promptless opens a docs PR, you can provide follow-on instructions directly through GitHub comments.
6+
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.
77

88
## Two ways of providing feedback
99

@@ -13,9 +13,7 @@ Leave individual comments on specific lines or sections of the documentation PR
1313

1414
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.
1515

16-
<Note>
17-
When using single comments, Promptless doesn't yet have the ability to look at other previous comments. So instructions like "Same here" wouldn't work. You can either spell out the instruction completely, or use the PR review comments below, where Promptless will have context on other comments in the same review.
18-
</Note>
16+
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.
1917

2018
### 2. PR reviews
2119

fern/docs/integrations/github.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,12 @@ Once configured, your specified trigger directories will be visible in the proje
9090

9191
When trigger directories are specified, only PRs that contain changes to those directories will be considered, and updates to other files will be ignored.
9292

93+
## Automated CI Check and Build Issue Resolution
94+
95+
When Promptless opens a documentation PR, it automatically monitors the pull request for quality issues. If CI checks fail, linting tools report errors, Vale rules trigger warnings, or your documentation hosting provider detects broken links or build problems, Promptless will automatically analyze the issues and push fixes directly to the PR branch.
96+
97+
This automated issue resolution works seamlessly with your existing GitHub workflow - there's no additional configuration needed. Quality problems get resolved in the background while you focus on content rather than troubleshooting technical issues.
98+
9399
## Authentication Model
94100

95101
Promptless uses the official [GitHub App specification](https://docs.github.com/en/apps/creating-github-apps/about-creating-github-apps) to authenticate with GitHub. Promptless authenticates securely with JWTs generated by the GitHub App installation.

0 commit comments

Comments
 (0)