diff --git a/docs/assets/images/collaboration/github-pr-comment-from-recce.png b/docs/assets/images/collaboration/github-pr-comment-from-recce.png new file mode 100644 index 0000000..ac2c1b5 Binary files /dev/null and b/docs/assets/images/collaboration/github-pr-comment-from-recce.png differ diff --git a/docs/assets/images/collaboration/gitlab-mr-comment-from-recce.png b/docs/assets/images/collaboration/gitlab-mr-comment-from-recce.png new file mode 100644 index 0000000..8a6c242 Binary files /dev/null and b/docs/assets/images/collaboration/gitlab-mr-comment-from-recce.png differ diff --git a/docs/assets/images/collaboration/recce-activity-mention.png b/docs/assets/images/collaboration/recce-activity-mention.png new file mode 100644 index 0000000..eaa9155 Binary files /dev/null and b/docs/assets/images/collaboration/recce-activity-mention.png differ diff --git a/docs/collaboration/activity.md b/docs/collaboration/activity.md index 6686d1a..eb23b40 100644 --- a/docs/collaboration/activity.md +++ b/docs/collaboration/activity.md @@ -13,41 +13,35 @@ Each check in your checklist has its own Activity panel. It records everything t Activity captures all events for a check: -- **Created** - When the check is added to the checklist -- **Approvals** - When the check is approved or unapproved -- **Comments** - Questions, discussions, and clarifications about the check -- **Description updates** - Changes to the check's description +- **Created**: When the check is added to the checklist +- **Approvals**: When the check is approved or unapproved +- **Comments**: Questions, discussions, and clarifications about the check +- **Description updates**: Changes to the check's description ![Activity panel in Recce Cloud](../assets/images/using-recce/checklist-review.png){: .shadow} -## Using Activity +## When to Use -### Discuss a Specific Check +- **Requesting context**: Ask the developer about unexpected results or ask reviewers about the acceptable thresholds +- **Documenting decisions**: Record the process of making a decision +- **Tracking history**: See who approved, what questions were asked, and how descriptions changed +- **Handoff scenarios**: Give the next reviewer context on past decisions -Use Activity to have focused conversations about a validation: +## Sync Comments to GitHub/GitLab -- Ask why a particular diff result is expected -- Request clarification on acceptable thresholds -- Discuss edge cases the check might miss -- Document why a check was approved despite warnings +When your Git provider is connected to Recce, comments you post in Activity automatically sync to the PR or MR. Each comment appears as a new comment on GitHub or GitLab, with a link back to the specific check in Recce. -### Track Check History +![Post a comment in Recce Activity](../assets/images/collaboration/recce-activity-mention.png){: .shadow} -Activity shows the lifecycle of each check: +The comment appears on the PR/MR: -- Who approved it and when -- What questions were asked before approval -- How the description changed over time -- Whether it was re-run after updates +![Comment posted to GitHub PR](../assets/images/collaboration/github-pr-comment-from-recce.png){: .shadow} -This history helps new reviewers understand past decisions. +You can @mention teammates using their GitHub or GitLab username (e.g., `@john-doe`). They'll receive a notification through GitHub or GitLab. Use the exact username—Recce doesn't currently map display names to usernames. -## When to Use +This works the same way on GitLab: -- **Requesting context** - Ask the developer about unexpected results -- **Documenting decisions** - Explain why you approved despite a warning -- **Iterating on checks** - Track changes as the developer updates code -- **Handoff scenarios** - Give the next reviewer context on your findings +![Comment posted to GitLab MR](../assets/images/collaboration/gitlab-mr-comment-from-recce.png){: .shadow} ## Related