Skip to content

Documentation fixes for examples - #12

Closed
sadie-niblett wants to merge 16 commits into
USACE-RMC:mainfrom
sadie-niblett:documentation-fixes
Closed

sadie-niblett wants to merge 16 commits into
USACE-RMC:mainfrom
sadie-niblett:documentation-fixes

Conversation

@sadie-niblett

@sadie-niblett sadie-niblett commented Aug 10, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Updated the examples folders by adding screenshots and tables from BestFit for peer review. Double checked formatting and flow.

Related Issue

Image Links broken in example directory markdown documents #10

Changes

  • Modified all .md files in examples folder with new image file locations
  • Modified all .md in examples with output table information from BestFit
  • Added "images" folders to separate and sort corresponding screenshots from BestFit for .md files

Test Plan

  • Model-library tests pass locally (dotnet test src/RMC.BestFit.Tests/RMC.BestFit.Tests.csproj -c Release)
  • New or changed public behavior has unit tests
  • Documentation or examples were updated when behavior changed
  • No new build warnings introduced

Checklist

  • Public types and members have XML documentation
  • Changes are focused and do not include unrelated formatting churn
  • I have read CONTRIBUTING.md
  • I agree to the Developer Certificate of Origin (DCO)

HadenSmith added a commit that referenced this pull request Oct 8, 2026
Reconcile PR #12 at f8df484 with documentation-verification-updates at
ed6f39a, preserving both histories and Sadie Niblett's citation credit.
Keep every current saved project, backup, dataset and scientific source
artifact unchanged. Retain the current scientific explanations, tables,
retirements and additional Python figure coverage.

Integrate the desktop walkthroughs and 122 current native captures with
per-view provenance, explicit dispositions for all 135 contributor PNGs,
and a 40-path data disposition. Correct view selection, diagnostic labels,
fractional/calendar ticks and citation quoting. Add reproducible native
panel capture and source/receipt verification without production changes.

Validation: 39 rendered pages with zero broken local links; complete
protected/staged-tree hash audit; all captures visually reviewed;
5,790 required fast .NET tests and 29 focused Python checks passed;
independent scientific, preservation and tooling review completed.
No saved estimator reruns; existing POT diagnostic display fits disclosed.
@HadenSmith

Copy link
Copy Markdown
Contributor

Thanks, @sadie-niblett! I’ve integrated your example-documentation contributions into the documentation-verification-updates branch, now included in PR #20, preserving your commits and citation credit. The examples were reconciled with the latest saved project results, and the app figures were refreshed against those projects. I’m closing this PR because the integrated work is now included in #20.

@HadenSmith HadenSmith closed this Oct 8, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants