Documentation unclear about PR comment functionality vs Deployment status

[danielboothcloud]

Documentation unclear about PR comment functionality vs Deployment status

Current Behavior

The repository's README shows examples of ArgoCD Commenter providing PR comments when applications sync/fail, but does not clearly document how to enable this functionality.

Documentation Gap

The only documented annotation is:

argocd-commenter.int128.github.io/deployment-url: https://api.github.com/repos/OWNER/REPO/deployments/ID

This appears to be specifically for GitHub Deployments API integration, but there's no clear documentation on:

1. How to enable basic PR comments without using Deployments API
2. What annotations (if any) are needed for PR comments
3. Whether PR comments require GitHub Actions setup

Expected Behavior

Documentation should clearly explain:

1. The difference between PR comments vs Deployment status features
2. Required configuration for each feature
3. Any required annotations and their exact format

Questions

1. Is PR commenting a supported feature separate from Deployment status?
2. If so, what configuration/annotations are needed?
3. If not, should the PR comment examples be clarified as requiring Deployment API integration?

Environment

• ArgoCD Commenter version: v1.8.0
• Kubernetes version: 1.28
• GitHub authentication: GitHub App (configured and working)