Triggers

Triggers are events that initiate automated documentation updates in Promptless. They’re designed to integrate seamlessly into your existing workflow, minimizing friction when creating and maintaining documentation.

Supported Triggers

GitHub / Bitbucket / GitLab

Promptless automatically monitors your specified source repositories for new pull requests. When a PR/MR is opened, the system analyzes the changes to determine if documentation updates are needed.

During analysis, Promptless processes information such as the code diff, PR title, and PR description to understand the context and scope of changes. This information is used solely for generating documentation suggestions and is not stored by Promptless.

You can configure specific directories to monitor, focusing documentation efforts on relevant parts of your codebase.

Slack Integration

Slack integration enables documentation updates directly from your team conversations. This is particularly useful for support conversations or internal discussions where questions arise that could be better addressed in your documentation.

Trigger methods:

• Message Action: Use the Promptless message shortcut on any Slack message to trigger documentation analysis
• Mentions: Tag @Promptless in a channel to request documentation updates based on the conversation context

Image Processing in Slack Threads

When triggered in threads containing images, Promptless analyzes both text and visual content. Relevant images are automatically included in documentation updates, securely stored, and formatted for your documentation platform.