From e31a52f668e9e651c858c70d0fe1e04dcae1561a Mon Sep 17 00:00:00 2001 From: "promptless[bot]" <179508745+promptless[bot]@users.noreply.github.com> Date: Thu, 25 Sep 2025 20:36:35 +0000 Subject: [PATCH 1/9] Documentation updates from Promptless --- fern/docs/changelogs/2025-09.md | 2 ++ fern/docs/features/github-pr-comments.mdx | 2 +- fern/docs/integrations/github.mdx | 6 ++++++ 3 files changed, 9 insertions(+), 1 deletion(-) diff --git a/fern/docs/changelogs/2025-09.md b/fern/docs/changelogs/2025-09.md index 8c8f050..8d944d5 100644 --- a/fern/docs/changelogs/2025-09.md +++ b/fern/docs/changelogs/2025-09.md @@ -7,3 +7,5 @@ title: September 2025 * **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. * **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. + +* **Automated Quality Assurance 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. diff --git a/fern/docs/features/github-pr-comments.mdx b/fern/docs/features/github-pr-comments.mdx index 9bcb0a5..97bf1ed 100644 --- a/fern/docs/features/github-pr-comments.mdx +++ b/fern/docs/features/github-pr-comments.mdx @@ -3,7 +3,7 @@ title: Interacting with Promptless PRs description: Learn how to provide follow-up instructions through GitHub PR comments and reviews after your documentation PR is opened --- -After Promptless opens a docs PR, you can provide follow-on instructions directly through GitHub comments. +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. ## Two ways of providing feedback diff --git a/fern/docs/integrations/github.mdx b/fern/docs/integrations/github.mdx index 3687074..dae1fd3 100644 --- a/fern/docs/integrations/github.mdx +++ b/fern/docs/integrations/github.mdx @@ -90,6 +90,12 @@ Once configured, your specified trigger directories will be visible in the proje When trigger directories are specified, only PRs that contain changes to those directories will be considered, and updates to other files will be ignored. +## Automated Quality Assurance + +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. + +This automated quality assurance 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. + ## Authentication Model 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. From 4c15a3c08fc7c2e1966f408b38b4b1e34de08884 Mon Sep 17 00:00:00 2001 From: "promptless[bot]" <179508745+promptless[bot]@users.noreply.github.com> Date: Fri, 26 Sep 2025 05:55:35 +0000 Subject: [PATCH 2/9] Sync documentation updates from Promptless agent --- fern/docs/changelogs/2025-09.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/fern/docs/changelogs/2025-09.md b/fern/docs/changelogs/2025-09.md index 8d944d5..2c44dbd 100644 --- a/fern/docs/changelogs/2025-09.md +++ b/fern/docs/changelogs/2025-09.md @@ -9,3 +9,5 @@ title: September 2025 * **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. * **Automated Quality Assurance 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. + +* **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. From 24d1f462988055e1d79e71e7010419e46cc16635 Mon Sep 17 00:00:00 2001 From: "promptless[bot]" <179508745+promptless[bot]@users.noreply.github.com> Date: Fri, 26 Sep 2025 16:43:01 +0000 Subject: [PATCH 3/9] Sync documentation updates from Promptless agent --- fern/docs/changelogs/2025-09.md | 2 +- fern/docs/integrations/github.mdx | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/fern/docs/changelogs/2025-09.md b/fern/docs/changelogs/2025-09.md index 2c44dbd..5c0f63a 100644 --- a/fern/docs/changelogs/2025-09.md +++ b/fern/docs/changelogs/2025-09.md @@ -8,6 +8,6 @@ title: September 2025 * **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. -* **Automated Quality Assurance 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. +* **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. * **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. diff --git a/fern/docs/integrations/github.mdx b/fern/docs/integrations/github.mdx index dae1fd3..1e93e41 100644 --- a/fern/docs/integrations/github.mdx +++ b/fern/docs/integrations/github.mdx @@ -90,11 +90,11 @@ Once configured, your specified trigger directories will be visible in the proje When trigger directories are specified, only PRs that contain changes to those directories will be considered, and updates to other files will be ignored. -## Automated Quality Assurance +## Automated CI Check and Build Issue Resolution 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. -This automated quality assurance 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. +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. ## Authentication Model From 8448763f07c71446f49103127724fc32c977fed4 Mon Sep 17 00:00:00 2001 From: "promptless[bot]" <179508745+promptless[bot]@users.noreply.github.com> Date: Mon, 29 Sep 2025 20:08:22 +0000 Subject: [PATCH 4/9] Sync documentation updates from Promptless agent --- fern/docs/changelogs/2025-09.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/fern/docs/changelogs/2025-09.md b/fern/docs/changelogs/2025-09.md index 5c0f63a..0d13057 100644 --- a/fern/docs/changelogs/2025-09.md +++ b/fern/docs/changelogs/2025-09.md @@ -8,6 +8,8 @@ title: September 2025 * **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. +* **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. + * **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. * **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. From 50685b881f45b6d4870867203de71a1efbee55f8 Mon Sep 17 00:00:00 2001 From: "promptless[bot]" <179508745+promptless[bot]@users.noreply.github.com> Date: Tue, 30 Sep 2025 13:13:35 +0000 Subject: [PATCH 5/9] Sync documentation updates from Promptless agent --- fern/docs/changelogs/2025-09.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/fern/docs/changelogs/2025-09.md b/fern/docs/changelogs/2025-09.md index 0d13057..fe823ed 100644 --- a/fern/docs/changelogs/2025-09.md +++ b/fern/docs/changelogs/2025-09.md @@ -4,6 +4,8 @@ title: September 2025 **Improvements:** +* **Claude Sonnet 4.5 Model Upgrade:** Promptless now uses Claude Sonnet 4.5 for all organizations, delivering improved documentation quality and more accurate technical writing. Previously limited to pilot organizations, this upgrade ensures everyone benefits from the latest AI model capabilities. + * **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. * **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. From 4bc947be721c96caaf04122420c3f41c7773a2ce Mon Sep 17 00:00:00 2001 From: "promptless[bot]" <179508745+promptless[bot]@users.noreply.github.com> Date: Tue, 30 Sep 2025 16:37:51 +0000 Subject: [PATCH 6/9] Sync documentation updates from Promptless agent --- fern/docs/changelogs/2025-09.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/fern/docs/changelogs/2025-09.md b/fern/docs/changelogs/2025-09.md index fe823ed..de1bc47 100644 --- a/fern/docs/changelogs/2025-09.md +++ b/fern/docs/changelogs/2025-09.md @@ -15,3 +15,5 @@ title: September 2025 * **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. * **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. + +* **Enhanced Suggestion Filtering:** Added 'PR Open' option to the suggestions dashboard status filters, making it easier to find suggestions that have been published as pull requests without typing search queries manually. From f5c3205a8a4c149d4f10579d3d9a1731fb690d4f Mon Sep 17 00:00:00 2001 From: "promptless[bot]" <179508745+promptless[bot]@users.noreply.github.com> Date: Wed, 1 Oct 2025 19:52:09 +0000 Subject: [PATCH 7/9] Sync documentation updates from Promptless agent --- fern/docs/changelogs/2025-09.md | 16 +++++++++++++++- fern/docs/integrations/github.mdx | 17 +++++++++++++++-- 2 files changed, 30 insertions(+), 3 deletions(-) diff --git a/fern/docs/changelogs/2025-09.md b/fern/docs/changelogs/2025-09.md index de1bc47..1de0eeb 100644 --- a/fern/docs/changelogs/2025-09.md +++ b/fern/docs/changelogs/2025-09.md @@ -14,6 +14,20 @@ title: September 2025 * **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. +* **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. + + + Warning dialog showing that the documentation PR will be opened as a draft since the trigger PR is not merged yet + + + + GitHub pull request showing draft status for Promptless documentation PR + + * **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. -* **Enhanced Suggestion Filtering:** Added 'PR Open' option to the suggestions dashboard status filters, making it easier to find suggestions that have been published as pull requests without typing search queries manually. +* **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." + + + PR Open filter option in the suggestions dashboard status dropdown + diff --git a/fern/docs/integrations/github.mdx b/fern/docs/integrations/github.mdx index 1e93e41..4eaa9ca 100644 --- a/fern/docs/integrations/github.mdx +++ b/fern/docs/integrations/github.mdx @@ -30,7 +30,7 @@ Promptless integrates with GitHub through our official GitHub App, providing sec Integrations Page -## Managing Repository Access After Installation +## Adding More Repos After Installation After the initial installation, you may need to add new repositories or modify which repositories Promptless can access. You can manage this directly through your GitHub organization settings: @@ -100,4 +100,17 @@ This automated issue resolution works seamlessly with your existing GitHub workf 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. -This ensures that Promptless has read and write access to the repositories that you select, and that either you or Promptless can revoke access at any time. \ No newline at end of file +This ensures that Promptless has read and write access to the repositories that you select, and that either you or Promptless can revoke access at any time. +## Frequently Asked Questions + +### How do I add more repositories after installing the GitHub integration? + +Add additional repositories anytime by visiting your GitHub organization settings. In GitHub, head to `Settings -> Third-party Access -> GitHub Apps` then find the Promptless GitHub App and click "Configure." Add or remove repositories in the "Repository access" section, then click "Save." You'll be able to choose from the newly added repositories when creating or editing your Promptless projects. + +### Can I remove GitHub repository access from Promptless? + +You can remove access to specific repositories or even uninstall the integration entirely from the same "Configure" page in your GitHub organization settings. Click the `×` next to a repository name to remove it from the Promptless GitHub App, or click the `Uninstall` button at the bottom of the page to remove the app entirely. + +### How long does it take for repository changes to appear in Promptless? + +It may take a few minutes for repository updates in the GitHub App to be reflected in your Promptless dashboard. If you don't see newly added repositories right away when creating or editing projects, click the "refresh repos" icon in the integrations page. \ No newline at end of file From 18a16022588675df6dcd1f9512e99131c427ffcd Mon Sep 17 00:00:00 2001 From: "promptless[bot]" <179508745+promptless[bot]@users.noreply.github.com> Date: Wed, 22 Oct 2025 20:31:59 +0000 Subject: [PATCH 8/9] Sync documentation updates from Promptless agent --- fern/docs/changelogs/2025-09.md | 2 ++ fern/docs/features/github-pr-comments.mdx | 4 +--- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/fern/docs/changelogs/2025-09.md b/fern/docs/changelogs/2025-09.md index 1de0eeb..169819b 100644 --- a/fern/docs/changelogs/2025-09.md +++ b/fern/docs/changelogs/2025-09.md @@ -8,6 +8,8 @@ title: September 2025 * **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. +* **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. + * **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. * **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. diff --git a/fern/docs/features/github-pr-comments.mdx b/fern/docs/features/github-pr-comments.mdx index 97bf1ed..cf38b96 100644 --- a/fern/docs/features/github-pr-comments.mdx +++ b/fern/docs/features/github-pr-comments.mdx @@ -13,9 +13,7 @@ Leave individual comments on specific lines or sections of the documentation PR 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. - - 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. - +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. ### 2. PR reviews From 4d6baf93d0c6596b9a79ef09330f115b3563f01c Mon Sep 17 00:00:00 2001 From: frances720 Date: Tue, 28 Oct 2025 15:26:46 -0700 Subject: [PATCH 9/9] Update fern/docs/changelogs/2025-09.md --- fern/docs/changelogs/2025-09.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/fern/docs/changelogs/2025-09.md b/fern/docs/changelogs/2025-09.md index 169819b..e01580e 100644 --- a/fern/docs/changelogs/2025-09.md +++ b/fern/docs/changelogs/2025-09.md @@ -4,8 +4,6 @@ title: September 2025 **Improvements:** -* **Claude Sonnet 4.5 Model Upgrade:** Promptless now uses Claude Sonnet 4.5 for all organizations, delivering improved documentation quality and more accurate technical writing. Previously limited to pilot organizations, this upgrade ensures everyone benefits from the latest AI model capabilities. - * **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. * **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.