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

docs: Update GitHub Integration Documentation to Highlight Trigger Events in PR Descriptions #145

Merged
merged 2 commits into from
May 23, 2025
Merged

docs: Update GitHub Integration Documentation to Highlight Trigger Events in PR Descriptions #145

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
999e3d6
Documentation updates from Promptless
promptless[bot] May 22, 2025
2a12eaa
Update docs/integrations/github.mdx
prithvi2206 May 23, 2025
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
13 changes: 12 additions & 1 deletion docs/integrations/github.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,17 @@ For example, in the below example, Promptless is only able to read the `promptle

<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)"}} />

## 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.
Expand All @@ -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.