Triggers
Triggers are events that initiate automated documentation updates in Promptless. When a trigger event occurs, Promptless analyzes the context and determines if documentation updates are needed.
Available Trigger Types
Section titled “Available Trigger Types”
GitHub PRs
Automatically triggered when pull requests are opened in your GitHub repositories
GitHub Commits
Monitor direct commits to default branches for documentation updates
Slack
Trigger updates from Slack conversations and support threads
Microsoft Teams
Trigger updates from Microsoft Teams messages and mentions
Zendesk (Beta)
Monitor support tickets for documentation gaps based on recurring user questions
Intercom (Beta)
Monitor support conversations for documentation gaps based on recurring user questions
How Triggers Work
Section titled “How Triggers Work”When a trigger event occurs:
- Event Detection: Promptless receives notification of the event (PR opened, message posted, ticket resolved)
- Context Analysis: The system analyzes the event content, including code changes, conversations, or support interactions
- Relevance Assessment: Promptless determines if the event requires documentation updates
- Suggestion Creation: If relevant, Promptless creates documentation suggestions based on the trigger content and connected context sources
Configuring Triggers
Section titled “Configuring Triggers”Triggers are configured at the project level in your projects page. For each project, you can:
- Select which trigger types to enable
- Configure trigger-specific settings (e.g., repository filters, channel selections)
- Set up auto-publish behavior for documentation updates
- Define notification preferences for your team
Need a trigger type that isn’t currently supported? Contact us at help@gopromptless.ai - we regularly add new trigger types based on user feedback.
Auto-publish Mode
Section titled “Auto-publish Mode”When auto-publish is enabled for your project, Promptless automatically creates pull requests in your documentation repository with suggested changes. For commit triggers, you can optionally enable auto-merge to automatically merge documentation PRs as soon as they’re created.
Auto-publish is available for all Git-hosted documentation platforms.
Trigger Events in Documentation PRs
Section titled “Trigger Events in Documentation PRs”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.