Skip to content

LifeSim Applications Guide ready for official release/move up the review chain.#115

Closed
karenmai-usace wants to merge 57 commits intomainfrom
docs/applications-guide
Closed

LifeSim Applications Guide ready for official release/move up the review chain.#115
karenmai-usace wants to merge 57 commits intomainfrom
docs/applications-guide

Conversation

@karenmai-usace
Copy link
Copy Markdown
Collaborator

@karenmai-usace karenmai-usace commented Apr 21, 2026

Description

Official release of LifeSIm Applications Guide: a guidance document and best practices for LifeSim modelers/Consequence Specialists based on various project types.

Affected documents

  • Newly created docs/desktop-applications/lifesim/applications-guide mdx's
  • Majority of figures pertaining to Applications Guide: updated since its creation a few years ago
  • Created bib.json for Applications Guide
  • Updated src/pages/desktop-applications/lifesim.js to reorder pages in order of recommended reading
  • Updated src/theme/Layout/buildNavLinks.js to reorder pages in order of recommended reading

Related issue(s)

No issues identified.

Pre-submission checklist

  • I have previewed these changes locally or via the PR preview URL
  • My branch name uses one of the expected prefixes: docs/new/, docs/major/, docs/minor/, or docs/fix/
    Note: Created branch name before reading the proper workflow to be docs/new. Apologies. Should be docs/new/applications-guide
  • I have updated 00-version-history.mdx if this change warrants a version entry
  • I have assigned a specific peer reviewer via the Reviewers sidebar (if known)
    Note: I (Karen) am creating the pull request for Susie because it's easier. I will be the peer reviewer. GitHub does not allow me to assign myself as a reviewer. Woody assigned as Lead reviewer. Can be Paul too, but he is not set up yet in GitHub/Visual Studio Code.

Technical edit (Lanes 1, 2, and 3)

  • Technical edit comments addressed — ready for Director review

Notes for reviewers

Original Word Document went through technical review a few years ago by Sarah Mattingly and Ariel Feldman. Susie and Karen updated the document to appropriate 2026 standards / website aesthetics in 2026.

suzbyrd94 and others added 30 commits March 12, 2026 17:48
- Created citations
- Updated figure and table references
- Updated links
-added citations
-added links to other sections of the app guide and other docs
- citation edits
- links added
- 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
…-levees-and-floodwalls

- Created and added acronym appendix
- Italicized file names
- Gave the MMC an hyperlink to their "About Us" page
…, cropped a few visible window borders on Figures, and made transparent sections for figure136 for dark mode
… to>'s throughout site open on new tab instead of taking over the current tab., such as adding a reference to the Midland Dams cascading validation study.
…ers to some figures for dark mode aesthetics.
…de 2) Technical Manual 3) App Guide 4) Validation Studies)
@karenmai-usace karenmai-usace requested a review from a team as a code owner April 21, 2026 13:41
@github-actions github-actions Bot added the stage:needs-lane Awaiting admin to assign a review lane label Apr 21, 2026
@karenmai-usace karenmai-usace added the lane:new-doc New document review (Peer → Lead Civil → Technical Edit → Director) label Apr 21, 2026
@github-actions
Copy link
Copy Markdown

⚠️ Could not determine review lane

Branch docs/applications-guide starts with docs/ but does not match an expected sub-prefix (docs/new/, docs/major/, docs/minor/, docs/fix/, docs/dev/).

@usace-rmc/docs-admin please apply the correct lane:* label.

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 21, 2026

📄 Preview deployed for commit ba3b58e

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

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

@karenmai-usace karenmai-usace added stage:peer-review Currently in peer review stage:lead-civil-review Currently in RMC Lead Civil review and removed stage:needs-lane Awaiting admin to assign a review lane stage:peer-review Currently in peer review labels Apr 22, 2026
@AdamGohs AdamGohs added stage:peer-review Currently in peer review and removed stage:lead-civil-review Currently in RMC Lead Civil review labels Apr 22, 2026
@AdamGohs AdamGohs removed the request for review from Woodrow-Fields April 22, 2026 15:04
@AdamGohs
Copy link
Copy Markdown
Collaborator

Closing this pull request. I am going to open a fresh PR to manage the lane and stage requirements for the automated workflow.

@AdamGohs AdamGohs closed this Apr 22, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

lane:new-doc New document review (Peer → Lead Civil → Technical Edit → Director) stage:peer-review Currently in peer review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants