From 999e3d688d14ef3aefc3c0f9d844197efc678d5b Mon Sep 17 00:00:00 2001 From: "promptless[bot]" <179508745+promptless[bot]@users.noreply.github.com> Date: Thu, 22 May 2025 23:37:51 +0000 Subject: [PATCH 1/2] Documentation updates from Promptless --- docs/integrations/github.mdx | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/docs/integrations/github.mdx b/docs/integrations/github.mdx index 33bf527..9d6583b 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 teams 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 From 2a12eaa605baf7bbd3d1681ff662b9a623bc332e Mon Sep 17 00:00:00 2001 From: Prithvi Ramakrishnan Date: Thu, 22 May 2025 17:03:14 -0700 Subject: [PATCH 2/2] Update docs/integrations/github.mdx --- docs/integrations/github.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/integrations/github.mdx b/docs/integrations/github.mdx index 9d6583b..c4deb2f 100644 --- a/docs/integrations/github.mdx +++ b/docs/integrations/github.mdx @@ -36,7 +36,7 @@ The trigger events section in the PR description includes: - Brief descriptions of what triggered the documentation update - Easy navigation to review the context that prompted the changes -This feature helps teams understand why documentation changes were made and provides a clear audit trail for all updates. +This feature helps you understand why documentation changes were made and provides a clear audit trail for all updates. ## Directory-Specific Triggers