Skip to content
This repository was archived by the owner on Oct 6, 2026. It is now read-only.

Documentation: Update READMEs, INSTALL.md, and DOCKER.md - #250

Merged
mxkpp merged 4 commits into
developmentfrom
maxkipp-docs-sep-2026
Sep 29, 2026
Merged

mxkpp merged 4 commits into
developmentfrom
maxkipp-docs-sep-2026

Conversation

@mxkpp

@mxkpp mxkpp commented Sep 29, 2026

Copy link
Copy Markdown

Updates to various README.md files, INSTALL.md, and DOCKER.md.

Not all legacy content was reviewed for accuracy. In some cases, existing content was struck-through and new content was added. Largely, existing content was preserved, but some files were marked as potentially containing stale information.

Clarifying remarks were added about the latest golden-file tests (pytest), and about the NextGen/NWM v4 configuration files used by nwm-msw-mgr, versus the legacy configuration files that still exist in the repository.

For some aspects of the repository which have been moved out of this repository and into other repositories, notes were added about those moves and directing readers to those other repositories.

Additions

  • None

Removals

  • In documentatino files, struck-through some content to replace with newer content while preserving the original.
  • Marked some documentation files as potentially containing outdated information.

Changes

  • Updated documentation files.

Testing

  1. Not needed

Screenshots

Notes

Todos

Checklist

  • PR has an informative and human-readable title
  • Changes are limited to a single goal (no scope creep)
  • Code can be automatically merged (no conflicts)
  • Code follows project standards (link if applicable)
  • Passes all existing automated tests
  • Any change in functionality is tested
  • New functions are documented (with a description, list of inputs, and expected output)
  • Placeholder code is flagged / future todos are captured in comments
  • Visually tested in supported browsers and devices (see checklist below 👇)
  • Project documentation has been updated (including the "Unreleased" section of the CHANGELOG)
  • Reviewers requested with the Reviewers tool ➡️

Testing checklist

Target Environment support

  • Linux

@mxkpp
mxkpp merged commit ee64a0d into development Sep 29, 2026
7 checks passed
@mxkpp
mxkpp deleted the maxkipp-docs-sep-2026 branch September 29, 2026 16:37
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants