Skip to content
This repository was archived by the owner on Jul 4, 2025. It is now read-only.

Commit 5b104c3

Browse files
docs: Update GitHub Integration Documentation to Highlight Trigger Events in PR Descriptions (#145)
Co-authored-by: promptless[bot] <179508745+promptless[bot]@users.noreply.github.com> Co-authored-by: Prithvi Ramakrishnan <[email protected]>
1 parent 5724f10 commit 5b104c3

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

docs/integrations/github.mdx

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,17 @@ For example, in the below example, Promptless is only able to read the `promptle
4444

4545
<img src="/img/Github-project.png" alt="Project Setup" style={{width:"800px", display: "block", margin: "0 auto", boxShadow: "0 4px 8px rgba(0, 0, 0, 0.1)"}} />
4646

47+
## Trigger Events in Pull Request Descriptions
48+
49+
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.
50+
51+
The trigger events section in the PR description includes:
52+
- Links back to the original source (e.g., Slack threads, GitHub PRs, support tickets)
53+
- Brief descriptions of what triggered the documentation update
54+
- Easy navigation to review the context that prompted the changes
55+
56+
This feature helps you understand why documentation changes were made and provides a clear audit trail for all updates.
57+
4758
## Directory-Specific Triggers
4859

4960
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.

0 commit comments

Comments
 (0)