diff --git a/docs/changelogs/2025-06.md b/docs/changelogs/2025-06.md new file mode 100644 index 0000000..b8003ae --- /dev/null +++ b/docs/changelogs/2025-06.md @@ -0,0 +1,20 @@ +--- +sidebar_position: 1 +--- + +# June 2025 + +## New Features + +### Replay Recent PRs/MRs on Project Setup + +When setting up a new GitHub, Bitbucket, or GitLab project, you can now choose to have Promptless analyze recent pull requests or merge requests from the past 1-30 days. This "replay" feature helps you catch up on documentation for changes that occurred before Promptless was configured. + +**How it works:** +- Enable the "Replay Pull Requests from the last N days" option when creating a new project +- Choose between 1-30 days to look back for recent PRs/MRs +- Promptless automatically analyzes these recent changes and suggests documentation updates as needed +- Works with all supported repository platforms (GitHub, Bitbucket, GitLab) +- Respects your project's directory-specific trigger settings + +This feature is particularly useful for teams adding Promptless to existing projects with active development. \ No newline at end of file diff --git a/docs/core-concepts/triggers.md b/docs/core-concepts/triggers.md index 0a5ef94..52b5d3f 100644 --- a/docs/core-concepts/triggers.md +++ b/docs/core-concepts/triggers.md @@ -14,6 +14,8 @@ When configured, Promptless automatically runs whenever a new pull request is op During the review process, if you need additional changes or have specific requests for the documentation updates, you can use the follow-on request feature. This allows you to provide additional instructions or feedback to Promptless, which will then process your request and suggest updated changes based on your input. +When setting up a new GitHub project, you can optionally enable the replay feature to analyze recent pull requests from the past 1-30 days. This helps catch up on documentation for changes that occurred before Promptless was configured. + ### Bitbucket Pull Requests Similar to GitHub, Promptless can be triggered by pull requests in Bitbucket repositories. When a new pull request is opened in your specified Bitbucket repositories, Promptless analyzes the changes and suggests documentation updates if needed. You can configure specific directories to monitor for changes, allowing you to focus documentation efforts on the most relevant parts of your codebase. @@ -22,6 +24,8 @@ The workflow for Bitbucket triggers follows the same pattern as GitHub triggers, Note that Promptless automatically skips draft pull requests in Bitbucket. Documentation updates will only be triggered when the pull request is marked as ready for review. +When setting up a new Bitbucket project, you can optionally enable the replay feature to analyze recent pull requests from the past 1-30 days. This helps catch up on documentation for changes that occurred before Promptless was configured. + ### Slack Integration When configured, Promptless can be triggered from Slack channels to find documentation updates that may be warranted from a thread. Primarily, this is used in Slack Connect support channels with customers -- where in a thread, a customer asks a question about your product, your team has answered it, and when Promptless is triggered, it suggests documentation updates based on the content of the thread. This is particularly useful if you notice a common question that you think should be answered in the docs. diff --git a/docs/getting-started.mdx b/docs/getting-started.mdx index 57746fa..ba925a3 100644 --- a/docs/getting-started.mdx +++ b/docs/getting-started.mdx @@ -35,6 +35,17 @@ For GitHub or Bitbucket-based projects, you can enable auto-publish to automatic When reviewing documentation updates in the dashboard, you can use the follow-on request feature to ask Promptless for additional changes or refinements to its initial suggestions. This is particularly useful when you want to provide specific feedback or request modifications to the proposed documentation updates. +### Replay Recent PRs/MRs + +When setting up a new GitHub, Bitbucket, or GitLab project, you can choose to have Promptless analyze recent pull requests or merge requests from the past 1-30 days. This "replay" feature is particularly useful when you're setting up Promptless for an existing project and want to catch up on documentation for recent changes that occurred before Promptless was configured. + +To enable this feature: +1. Check the "Replay Pull Requests from the last" checkbox when creating your project +2. Specify the number of days (1-30) to look back for recent PRs/MRs +3. Promptless will automatically analyze these recent changes and suggest documentation updates as needed + +This feature works for all supported repository platforms (GitHub, Bitbucket, and GitLab) and respects your project's directory-specific trigger settings if configured. + A new project for a Github PR trigger might look like this: Create New Project modal diff --git a/docs/integrations/bitbucket.mdx b/docs/integrations/bitbucket.mdx index decf91e..1c14c37 100644 --- a/docs/integrations/bitbucket.mdx +++ b/docs/integrations/bitbucket.mdx @@ -55,6 +55,17 @@ To set up directory-specific triggers: 2. Under **Advanced Options**, enable **Directory-Specific Triggers** 3. Enter the directories you want to monitor, separated by commas (e.g., `src/api, docs/reference`) +### Replay Recent Pull Requests + +When setting up a new Bitbucket project, you can optionally enable the replay feature to analyze recent pull requests from the past 1-30 days. This is particularly useful when you're adding Promptless to an existing project and want to catch up on documentation for changes that occurred before Promptless was configured. + +To enable this feature: +1. Check the "Replay Pull Requests from the last" checkbox when creating your project +2. Specify the number of days (1-30) to look back for recent PRs +3. Promptless will automatically analyze these recent changes and suggest documentation updates as needed + +This feature respects your project's directory-specific trigger settings if configured, so it will only analyze PRs that contain changes to your specified directories. + ## Authentication Model The Bitbucket integration uses a username and app password authentication model: diff --git a/docs/integrations/github.mdx b/docs/integrations/github.mdx index 5dc03bf..81aa6cd 100644 --- a/docs/integrations/github.mdx +++ b/docs/integrations/github.mdx @@ -44,6 +44,17 @@ For example, in the below example, Promptless is only able to read the `promptle Project Setup +### Replay Recent Pull Requests + +When setting up a new GitHub project, you can optionally enable the replay feature to analyze recent pull requests from the past 1-30 days. This is particularly useful when you're adding Promptless to an existing project and want to catch up on documentation for changes that occurred before Promptless was configured. + +To enable this feature: +1. Check the "Replay Pull Requests from the last" checkbox when creating your project +2. Specify the number of days (1-30) to look back for recent PRs +3. Promptless will automatically analyze these recent changes and suggest documentation updates as needed + +This feature respects your project's directory-specific trigger settings if configured, so it will only analyze PRs that contain changes to your specified directories. + ## Trigger Events in Pull Request Descriptions When Promptless creates a pull request for documentation updates, it automatically includes a list of the trigger events that led to those changes in the PR description. This provides valuable context for reviewers and creates clear traceability between documentation updates and their originating events.