Skip to content

[Develop] Update SRW UG ahead of AQM release - #1352

Merged
MichaelLueken merged 26 commits into
ufs-community:developfrom
jdkublnick:text/uss-500
Feb 11, 2026
Merged

[Develop] Update SRW UG ahead of AQM release#1352
MichaelLueken merged 26 commits into
ufs-community:developfrom
jdkublnick:text/uss-500

Conversation

@jdkublnick

@jdkublnick jdkublnick commented Jan 27, 2026

Copy link
Copy Markdown
Collaborator

DESCRIPTION OF CHANGES:

  • Updating component.rst chapter with AQM and SD features
  • Misc spelling and grammar typos
  • DTC link updates
  • Platform updates (removing Ursa, adding jet).
  • Link to UW tools docs
  • Updating paths
  • Removed old notes
  • added glossary terms

Type of change

  • [X ] This change requires a documentation update

TESTS CONDUCTED:

N/A

DEPENDENCIES:

N/A

DOCUMENTATION:

N?A

ISSUE:

#1351

CHECKLIST

  • [X ] My changes need updates to the documentation. I have made corresponding changes to the documentation

  • [ X] My changes generate no new warnings

LABELS (optional):

  • [x ] documentation

CONTRIBUTORS (optional):

@jdkublnick jdkublnick changed the title [Develop [Develop] Update SRW UG ahead of AQM release Jan 27, 2026
@jdkublnick jdkublnick added the documentation Improvements or additions to documentation label Jan 27, 2026
@MichaelLueken MichaelLueken linked an issue Jan 27, 2026 that may be closed by this pull request

@MichaelLueken MichaelLueken left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Thank you very much for opening this PR to update the documentation for the community announcement for the AQM, @jdkublnick!

In doc/conf.py, is the intention to update the documentation to point to the spack RtD, or do we want to continue using spack-stack RtD?

If the change is to correct the failure in the doc_tests GitHub Action, then I would recommend using the suggested change instead. This will point to the spack-stack 1.9.2 documentation, which is the version of spack-stack that the UFS is using currently. However, if the update is to point to the latest spack documentation, then this update is fine.

Comment thread doc/conf.py Outdated
Co-authored-by: Michael Lueken <63728921+MichaelLueken@users.noreply.github.com>

@MichaelLueken MichaelLueken left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

@jdkublnick -

Thanks! Approving PR now.

@benkozi benkozi left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Thanks for the changes. Just a few minor comments.

Comment thread doc/UsersGuide/BackgroundInfo/Components.rst Outdated
Comment thread doc/UsersGuide/BackgroundInfo/Components.rst
Comment thread doc/UsersGuide/BackgroundInfo/Introduction.rst

@benkozi benkozi left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Apologies @jdkublnick, I didn't realize you had made the suggested changes. Approving now. Thanks!

@MichaelLueken
MichaelLueken merged commit b03302e into ufs-community:develop Feb 11, 2026
3 checks passed
@github-project-automation github-project-automation Bot moved this from In Review to Done in SRW App's PR Reviewers Feb 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

General Users Guide Update

3 participants