GitHub Issues

Promptless monitors GitHub issues for documentation requests. When @Promptless is mentioned in an issue, the system analyzes the issue content and creates documentation suggestions.

How It Works

When @Promptless is mentioned in a GitHub issue:

1. Acknowledgment: Promptless adds a 👀 reaction to the issue to indicate processing has started
2. Analysis: Promptless reads the issue title, description, and comments to understand the documentation request
3. Relevance Assessment: Promptless determines if the issue content warrants documentation updates
4. Suggestion Creation: If relevant, Promptless creates documentation suggestions and posts results back to the issue

Note

If no pipelines are configured to handle the issue, Promptless will post a comment explaining that no matching configuration was found. This helps you understand why no documentation update was triggered.

When to Use GitHub Issues Triggers

GitHub Issues triggers are useful for:

• Documentation requests: Contributors or users can open issues requesting specific documentation improvements
• Open-source projects: Community members can tag Promptless in issues to generate documentation updates without needing access to other tools
• Tracking documentation gaps: Issues provide a natural place to discuss and track documentation needs before they’re addressed

Configuration

Configure GitHub Issues triggers in your project settings:

1. Select GitHub as your trigger source
2. Choose which repositories to monitor for issue mentions
3. Set auto-publish preferences
4. Configure notification channels

GitHub Issues triggers require the same GitHub App installation used for PR triggers. See the GitHub Integration setup guide if you haven’t connected GitHub yet.

Setup Instructions

To connect GitHub to Promptless, see the GitHub Integration setup guide.