Docs/applications guide - #116
Merged
Merged
Conversation
…ed editing the Dams chapter (05).
- Created citations - Updated figure and table references - Updated links
…C/RMC-Software-Documentation into docs/applications-guide
-added citations -added links to other sections of the app guide and other docs
- citation edits - links added
…C/RMC-Software-Documentation into docs/applications-guide
- text edits
-updated figures for better resolution
…o match Woody's QC of Validation Studies - Added HEC-RAS citation to Introduction mention in step 8 - Added NSI Documentation hyperlink - Capitilized titles in occ type table - Added three dots, checkbox, and unchecked inline images - Added comment regarding whether breach/non-breach should be updated to fail(ure)/non-fail(ure) MMC/RMC terminology
…C/RMC-Software-Documentation into docs/applications-guide
…C/RMC-Software-Documentation into docs/applications-guide
…C/RMC-Software-Documentation into docs/applications-guide
…C/RMC-Software-Documentation into docs/applications-guide
…ges and turn the page on
…-levees-and-floodwalls - Created and added acronym appendix - Italicized file names - Gave the MMC an hyperlink to their "About Us" page
…laude's findings.
…C/RMC-Software-Documentation into docs/applications-guide
|
🔄 New commits pushed by @Gman-1789 — please backcheck the revisions for Lead Civil reviewer(s). |
…tion page rather than version 6.6, 7.0, etc. - Cleaned border of 3 figures and added transparency to arrow in figure137 - Removed title commas in the Introduction list - Updated NSI references - Fixed hyperlinks and bolded text that were line breaking weird - Checked compatality of whole document with dark mode and small screen
|
🔄 New commits pushed by @Gman-1789 — please backcheck the revisions for Lead Civil reviewer(s). |
|
🔄 New commits pushed by @Gman-1789 — please backcheck the revisions for Lead Civil reviewer(s). |
AdamGohs
added
stage:ai-editor-review
AdamGohs
commented
Aug 26, 2026
AdamGohs
left a comment
AdamGohs
left a comment
Collaborator
Author
There was a problem hiding this comment.
AI Technical Edit
139 comments across 13 files. Review prompt version: abbc319 (.github/ai-review/technical-editor-prompt.md, 2026-04-10).
| Severity | Count |
|---|---|
| 🔴 Must fix | 56 |
| 🟡 Should fix | 71 |
| 🔵 Suggestion | 12 |
Highest-impact items
- Ten figures will 404 in production. Ten
srcpaths differ in case from the actual filenames (introfigure.pngvsIntroFigure.png, etc.). Windows resolves these; the case-sensitive build/host will not. See03-summary-of-lifesim-inputs.mdx:251and04-estimating-consequences-for-levees-and-floodwalls.mdx:1139. - Section 508: ~30 unlabeled images.
<FigureInline>emits an<img>with noaltattribute at all (src/components/FigureInline.js:8). Fix is in the component, not the MDX. - Markdown emphasis is corrupting shapefile names at
05-estimating-consequences-for-dams.mdx:275-276(EPZ*NoDoubleWarning,\_Mileage_Reaches.shp*). - A link's text names the wrong chapter at
09-estimating-direct-economic-damages.mdx:298. - Undefined acronyms in running text: USGS, NWS (
04:403), ECAM (05:608), OT (07:371), RMC (06:26), plus MH/IH used where MHP/IHP is defined (05:436). Appendix A is also missing 12 acronyms the guide uses and lists 5 it never uses. - Typos and agreement errors throughout:
focues,questionairre,identifible,segement,subjectec,HazardOccurrence,that that,larger that,need cleaned up,an Hydrologic.
Cross-cutting consistency (flagged once each, with line lists)
- Voice — first person (
Iat04:264;we/ourat04:415,04:436,05:157,05:330,05:686,05:741) and third/second person alternation (the uservsyou) inside single paragraphs. - Tense — chapter 5 describes the UI in the future tense while chapters 3, 4, and 7 use the present.
- Units and numbers —
2ft/2-foot/2 ft,2amvs02:00,8vseight,200,000 dollarsvs$200,000. - Typography — straight and curly quotes/apostrophes mixed within single paragraphs.
- Hyphenation —
right click,double click,left clickingused as verbs;two zone EPZ;shelter-in-placeas a verb.
Everything below is anchored to a specific line. Nothing has been edited — all changes are the author's call.
The src values used lowercase filenames while the committed image files use mixed case. Windows resolves either, so local builds worked, but the GitHub Pages deploy is case-sensitive and returned 404 for figures 2, 67, 68, 69, 70, 77, 81, 82, 83, and 88.
Updated "Approved By" column in LifeSim Applications Guide. Updated the site's change log to reflect Applications Guide release.
Update DraftNotice.js so it renders the draft strip on the Preview site prior to deployment.
github-actions
Bot
added
stage:director-review
|
✅ Technical edit marked complete by the author. Advancing to Director review. @usace-rmc/docs-admin please trigger the checkpoint deploy of |
AdamGohs
added
stage:ready-to-merge
github-actions
Bot
removed
the
admin:approve-merge-after-push
|
✅ Post-push merge re-approved by |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This pull request merges the LifeSim Applications Guide into the RMC Software Documentation website.
Affected documents
Related issue(s)
Pre-submission checklist
docs/new/,docs/major/,docs/minor/, ordocs/fix/00-version-history.mdxif this change warrants a version entryTechnical edit (Lanes 1, 2, and 3)
Notes for reviewers