Skip to content

Breach Toolbox v1.1: correct EBL (2005) equation exponents#119

Merged
AdamGohs merged 4 commits into
mainfrom
docs/minor/breach-v1.1
May 19, 2026
Merged

Breach Toolbox v1.1: correct EBL (2005) equation exponents#119
AdamGohs merged 4 commits into
mainfrom
docs/minor/breach-v1.1

Conversation

@AdamGohs
Copy link
Copy Markdown
Collaborator

@AdamGohs AdamGohs commented May 19, 2026

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

  • RMC Breach Toolbox Technical Manual (new v1.1)

Review guidance

The PR is structured as two commits so the substantive change is easy to verify in isolation:

  1. Scaffold v1.1 of Breach Toolbox Technical Manual — verbatim copy of v1.0/ to v1.1/ (docs, figures, bibliography). No content changes. Safe to skim; you can mark these files "Viewed" on the Files changed tab.
  2. 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 fix
    • v1.1/00-version-history.mdx — new v1.1 row
    • src/pages/changelog.js — new site-wide changelog row

The change in equation 15:

- d_{50} = 0.43 q_{t}^{0.43} S_{o}^{0.78}
+ d_{50} = 0.43 S_{o}^{0.43} q_{t}^{0.78}

Pre-submission checklist

  • Previewed locally — v1.1 builds, equation renders correctly, v1.0 remains untouched with the "newer version available" banner
  • Branch prefix docs/minor/ → Lane 3 (Peer review only)
  • 00-version-history.mdx updated with v1.1 row (description, modifier, peer reviewer pre-filled)

Technical edit (Lanes 1, 2, and 3)

  • Technical edit comments addressed — ready to merge

Notes for reviewers

The draft: true flag was intentionally not set in src/docConfig.js for 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.mdx still reference v1.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.

AdamGohs added 2 commits May 19, 2026 14:01
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.
@AdamGohs AdamGohs requested a review from a team as a code owner May 19, 2026 18:02
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 19, 2026

📋 Assigned reviewers for this PR

  • Peer reviewer(s): @Cacumm02
  • 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 github-actions Bot added lane:minor-revision Minor revision (Peer review only) stage:peer-review Currently in peer review labels May 19, 2026
@github-actions
Copy link
Copy Markdown

📋 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
Copy link
Copy Markdown

github-actions Bot commented May 19, 2026

📄 Preview deployed for commit becdb9b

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.

@AdamGohs AdamGohs requested a review from Cacumm02 May 19, 2026 18:11
Cacumm02
Cacumm02 previously approved these changes May 19, 2026
@github-actions github-actions Bot added stage:ai-editor-review Currently in technical editor review and removed stage:peer-review Currently in peer review labels May 19, 2026
@github-actions
Copy link
Copy Markdown

Peer review approved by @Cacumm02.

Advancing to technical edit.

@usace-rmc/docs-admin please run the /technical-edit Claude Code skill against this PR (or assign a human technical editor). The technical edit reviews the document source MDX directly and posts inline comments on the PR.

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.

Copy link
Copy Markdown
Collaborator Author

@AdamGohs AdamGohs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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:

  1. Fold these fixes into this PR — clean option, v1.1 hasn't shipped yet
  2. 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.

Comment thread docs/toolbox-technical-manuals/internal-erosion-suite/breach/v1.1/07-sinkhole.mdx Outdated
Comment thread docs/toolbox-technical-manuals/internal-erosion-suite/breach/v1.1/07-sinkhole.mdx Outdated
Comment thread docs/toolbox-technical-manuals/internal-erosion-suite/breach/v1.1/07-sinkhole.mdx Outdated
Comment thread docs/toolbox-technical-manuals/internal-erosion-suite/breach/v1.1/07-sinkhole.mdx Outdated
Comment thread docs/toolbox-technical-manuals/internal-erosion-suite/breach/v1.1/07-sinkhole.mdx Outdated
Comment thread docs/toolbox-technical-manuals/internal-erosion-suite/breach/v1.1/07-sinkhole.mdx Outdated
@github-actions github-actions Bot added stage:ready-to-merge All reviews complete, ready for final merge and removed stage:ai-editor-review Currently in technical editor review labels May 19, 2026
@github-actions
Copy link
Copy Markdown

Technical edit marked complete by the author.

This PR is ready for final merge and publication.

@usace-rmc/docs-admin next steps:

  1. Check out this branch
  2. Flip the document's draft flag to false
  3. Update 00-version-history.mdx
  4. Commit and push
  5. Merge to main
  6. Approve the production deploy

@AdamGohs AdamGohs merged commit 00ba013 into main May 19, 2026
6 checks passed
@AdamGohs AdamGohs deleted the docs/minor/breach-v1.1 branch May 19, 2026 21:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

lane:minor-revision Minor revision (Peer review only) stage:ready-to-merge All reviews complete, ready for final merge

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants