Sample Document for Reviewer Training (do not merge)

[AdamGohs]

Purpose

This PR is a permanent sandbox used to capture screenshots and GIFs for the Reviewer Workflow chapter of the Documentation Guide. Do not merge it, close it, or rebase it.

It exists so that contributors writing or updating the Reviewer Workflow chapter always have a realistic in-review PR to demonstrate the GitHub review UI against: assigned reviewers, the Files changed tab with a meaningful diff, the Commits tab with both a scaffolding commit and a content commit, the Conversation tab with inline review comments, the "Finish your review" dialog, and so on.

Why this document, this version

docs/desktop-applications/rmc-totalrisk/users-guide was chosen because (a) it has an existing v1.0 to bump from, (b) it is stable and not on anyone's immediate development roadmap, and (c) its size (17 chapters, ~200 figures, a bibliography, and source documents) makes it a representative example of the work product reviewers will encounter.

Commits in this PR

1. Scaffold v1.1 of RMC TotalRisk Users Guide — copies v1.0 documents, figures, and bibliography into a new v1.1 folder; adds a placeholder row to 00-version-history.mdx; flips draft: true in src/docConfig.js. No content changes — this is the boilerplate commit that reviewers should skip past.
2. Update preface, installation, GUI, and acronyms for v1.1 — modest, realistic minor-revision edits to four chapters (~16 lines added, 8 removed). This is the commit reviewers should actually focus on.

The two-commit shape is intentional. The Reviewer Workflow chapter teaches reviewers how to navigate the Commits tab and skip the scaffolding commit, and this PR provides the live example.

Lifecycle

• Stage: leave in stage:peer-review indefinitely
• Merging: do not merge. If this PR is accidentally approved and the stage progression workflow advances it past peer review, a site administrator should reset the stage labels and re-open the conversation.
• Updating: small additions are fine (e.g., a new inline comment for a screenshot capture) but the overall scaffold should remain stable so historic screenshots in the Documentation Guide stay representative of what reviewers will see.

Affected documents

• desktop-applications/rmc-totalrisk/users-guide (v1.0 → v1.1, never published)

Related issues

None — this is a tooling PR for documentation, not a real revision.

[github-actions]

📋 Assigned reviewers for this PR

• Peer reviewer(s): @rmctestreviewer
• Lead Civil reviewer(s): not assigned
• Technical editor(s): not assigned
• Director reviewer(s): not assigned

The first approval from any assigned reviewer at the current stage advances the PR. Approvals from non-assigned reviewers are logged but do not advance the stage.

[github-actions]

📋 Lane: minor revision

Review scope: Peer → Technical Edit.

Currently in peer review. @usace-rmc/docs-admin please assign the peer reviewer(s) via the Reviewers sidebar.

[github-actions]

📄 Preview deployed for commit 7ae2022

https://usace-rmc.github.io/RMC-Software-Documentation-Previews/pr-121/

This preview updates automatically when new commits are pushed. Deleted when the PR closes.

[rmctestreviewer]

[Documentation training sandbox] This review was submitted programmatically by the figure-capture pipeline to produce screenshots for the Reviewer Workflow chapter. It is not a real review of the PR. Ignore.