Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions fern/docs/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ If you want to have both triggers, create two separate projects with all other i

For GitHub or Bitbucket-based projects, you can enable the auto-publish checkbox to automatically create pull requests with documentation changes. When enabled, Promptless will create a new PR with suggested documentation updates whenever it detects necessary changes, rather than requiring manual review and PR creation through the dashboard.

For GitHub projects specifically, you can also enable the "Process last 30 days of PRs after project creation" option to automatically replay recent pull requests. This feature processes all GitHub PRs from the past 30 days in your selected repositories, generating documentation suggestions for any changes that would have triggered Promptless. This is particularly useful during initial setup to catch up on recent development activity that may need documentation updates.

You can also configure excluded directories to prevent Promptless from analyzing or making suggestions for specific directories in your documentation repository. This is useful for excluding internal documentation, deprecated content, or directories that shouldn't be modified by automated processes. Simply check the "Exclude specific directories from Promptless suggestions" option and specify the directory paths (separated by commas) that you want to exclude.

Expand Down
13 changes: 13 additions & 0 deletions fern/docs/integrations/github.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,19 @@ For example, in the below example, Promptless is only able to read the `promptle
<img src="../assets/github-project.png" alt="Project Setup" />
</Frame>

## PR Replay for New Projects

When creating a new GitHub project, you have the option to "Process last 30 days of PRs after project creation." This feature automatically replays all GitHub pull requests from the past 30 days across your selected trigger repositories, generating documentation suggestions for any changes that would have triggered Promptless.

This is particularly useful during initial project setup to:
- Catch up on recent development activity that may need documentation updates
- Generate suggestions for PRs that were merged before Promptless was configured
- Ensure your documentation reflects recent code changes without manual review

The PR replay process runs as a background job after your project is created and may take several minutes to complete, depending on the number of recent PRs in your repositories. You'll receive notifications when the replay process begins and completes.

Note that this feature is currently available only for GitHub triggers and processes PRs that were opened (or merged) within the last 30 days, excluding any PRs that were closed without being merged.

## 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.
Expand Down