From 1b58bfd09670242d2e21df897a794f2e4d8a4bd7 Mon Sep 17 00:00:00 2001
From: Quaternions <krakow20@gmail.com>
Date: Thu, 26 Dec 2024 18:19:59 -0800
Subject: [PATCH] web: describe when each button should be visible

---
 .../submissions/[submissionId]/_reviewButtons.tsx    | 12 +++++++++++-
 1 file changed, 11 insertions(+), 1 deletion(-)

diff --git a/web/src/app/submissions/[submissionId]/_reviewButtons.tsx b/web/src/app/submissions/[submissionId]/_reviewButtons.tsx
index 0af3ba1..c5f227a 100644
--- a/web/src/app/submissions/[submissionId]/_reviewButtons.tsx
+++ b/web/src/app/submissions/[submissionId]/_reviewButtons.tsx
@@ -30,7 +30,17 @@ function ReviewButton(props: ReviewButton) {
 
 export default function ReviewButtons(props: SubmissionInfo) {
 	const submissionId = props.ID.toString()
-
+	// When is each button visible?
+	// Multiple buttons can be visible at once.
+	// Action         | Role      | When Current Status is One of:
+	// ---------------|-----------|-----------------------
+	// Submit         | Submitter | UnderConstruction, ChangesRequested
+	// Revoke         | Submitter | Submitted, ChangesRequested
+	// Accept         | Reviewer  | Submitted
+	// Validate       | Reviewer  | Accepted
+	// Reject         | Reviewer  | Submitted
+	// RequestChanges | Reviewer  | Validated, Accepted, Submitted
+	// Upload         | MapAdmin  | Validated
 	return (
 		<section className="review-set">
 			<ReviewButton color="info"  name="Submit"    action="submit"           submissionId={submissionId}/>