Breach Toolbox v1.1: correct EBL (2005) equation exponents#119
Conversation
Verbatim copy of v1.0/ to v1.1/ — no content changes. The substantive revision (equation correction) is in the following commit so reviewers can focus on it without wading through the bulk copy.
Swaps the exponents associated with downstream slope (S_o) and unit discharge (q_t) in equation 15 of the Unraveling chapter. Adds the v1.1 row to the document's version history table and a corresponding row to the site-wide change log.
|
📋 Assigned reviewers for this PR
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. |
|
📋 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. |
|
📄 Preview deployed for commit https://usace-rmc.github.io/RMC-Software-Documentation-Previews/pr-119/ This preview updates automatically when new commits are pushed. Deleted when the PR closes. |
|
✅ Peer review approved by @Cacumm02. Advancing to technical edit. @usace-rmc/docs-admin please run the After the author addresses the technical edit comments and checks the completion checkbox in the PR description, the site admin will flip the draft flag, merge, and deploy. |
AdamGohs
left a comment
There was a problem hiding this comment.
AI technical edit complete. 9 inline comments across 3 files.
Context: This PR adds v1.1 of the Breach Toolbox Technical Manual. Most v1.1 files are verbatim copies of v1.0, so several findings below are pre-existing v1.0 issues that this PR has the opportunity to fix (since v1.1 is the version being introduced). You can:
- Fold these fixes into this PR — clean option, v1.1 hasn't shipped yet
- Punt to a separate
docs/fix/PR — keeps this PR's scope strictly to the equation correction
Severity guide:
- 🔴 Must fix — clear grammar/terminology errors
- 🟡 Should fix — consistency issues
- 🔵 Suggestion — minor stylistic improvements
Files reviewed: 12 MDX files (the v1.1 folder)
Review prompt: .github/ai-review/technical-editor-prompt.md
When all comments are addressed, check the "Technical edit comments addressed" box in the PR description.
…RMC Breach Toolbox Technical Manual.
…C Breach Toolbox Technical Manual.
|
✅ Technical edit marked complete by the author. This PR is ready for final merge and publication. @usace-rmc/docs-admin next steps:
|
Description
Minor revision (v1.0 → v1.1) of the Breach Toolbox Technical Manual. Equation 15 in the Unraveling chapter (EBL 2005 method for median rock size needed for stability) had the exponents associated with downstream slope (
S_o) and unit discharge (q_t) swapped. This PR restores the correct association.Affected documents
Review guidance
The PR is structured as two commits so the substantive change is easy to verify in isolation:
Scaffold v1.1 of Breach Toolbox Technical Manual— verbatim copy ofv1.0/tov1.1/(docs, figures, bibliography). No content changes. Safe to skim; you can mark these files "Viewed" on the Files changed tab.Correct EBL (2005) equation exponents in Breach Toolbox v1.1— the actual revision. Please focus your review here. Three files, ~15 insertions / 10 deletions:v1.1/06-unraveling.mdx— the one-line equation fixv1.1/00-version-history.mdx— new v1.1 rowsrc/pages/changelog.js— new site-wide changelog rowThe change in equation 15:
Pre-submission checklist
docs/minor/→ Lane 3 (Peer review only)00-version-history.mdxupdated with v1.1 row (description, modifier, peer reviewer pre-filled)Technical edit (Lanes 1, 2, and 3)
Notes for reviewers
The
draft: trueflag was intentionally not set insrc/docConfig.jsfor this revision — the change is a single corrected equation and does not warrant a DRAFT watermark on the entire document during review.Figure paths in
v1.1/06-unraveling.mdxstill referencev1.0/figures/. The figures are bit-identical (copied), so this is cosmetic only; if the team prefers v1.1 paths everywhere, that can be a separate fix-up.