diff --git a/docs/integrations/github.mdx b/docs/integrations/github.mdx index 33bf527..c4deb2f 100644 --- a/docs/integrations/github.mdx +++ b/docs/integrations/github.mdx @@ -27,6 +27,17 @@ For example, in the below example, Promptless is only able to read the `promptle Project Setup +## 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. + +The trigger events section in the PR description includes: +- Links back to the original source (e.g., Slack threads, GitHub PRs, support tickets) +- Brief descriptions of what triggered the documentation update +- Easy navigation to review the context that prompted the changes + +This feature helps you understand why documentation changes were made and provides a clear audit trail for all updates. + ## Directory-Specific Triggers You can configure Promptless to only trigger when changes are made to specific directories within your repositories. This is particularly useful when you want to focus documentation updates on changes to certain parts of your codebase, such as changelog directories. @@ -50,4 +61,4 @@ When trigger directories are specified, only PRs that contain changes to those d 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. +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