Skip to content

Feature #82 users_guide_reorg #83

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Aug 6, 2025
Merged

Conversation

JohnHalleyGotway
Copy link
Contributor

@JohnHalleyGotway JohnHalleyGotway commented Aug 5, 2025

Pull Request Testing

  • Describe testing already performed for these changes:

    These changes represent a significant restructuring of the I-WRF documentation.

  • Recommend testing for the reviewer(s) to perform, including the location of input datasets, and any additional instructions:

    Please carefully review the proposed doc updates for this PR:
    https://i-wrf--83.org.readthedocs.build/en/83/
    Consider enabling the show diff option to highlight in green/red where the changes lie on any given page.

  • Do these changes include sufficient documentation updates, ensuring that no errors or warnings exist in the build of the documentation? [Yes]

  • Do these changes include sufficient testing updates? [Yes]
    None needed.

  • Will this PR result in changes to the test suite? [No]

    If yes, describe the new output and/or changes to the existing output:

    Doesn't exist to my knowledge

  • Please complete this pull request review by [Monday, Aug 11, 2025].

Pull Request Checklist

  • Review the source issue metadata (required labels, projects, and milestone).
  • Complete the PR definition above.
  • Ensure the PR title matches the feature or bugfix branch name.
  • Define the PR metadata, as permissions allow.
    Select: Reviewer(s)
    Select: Organization level software support Project or Repository level development cycle Project
    Select: Milestone as the version that will include these changes
  • After submitting the PR, select Development issue with the original issue number.
  • After the PR is approved, merge your changes. If permissions do not allow this, request that the reviewer do the merge.
  • Close the linked issue and delete your feature or bugfix branch from GitHub.

@JohnHalleyGotway JohnHalleyGotway linked an issue Aug 5, 2025 that may be closed by this pull request
30 tasks
@JohnHalleyGotway JohnHalleyGotway marked this pull request as ready for review August 5, 2025 21:49
Copy link
Contributor

@jaredalee jaredalee left a comment

Choose a reason for hiding this comment

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

In addition to my one minor comment on nsf-ncar.rst linking to CISL's instructions for accessing Derecho/Casper, please also remove "5.2. Customizing Datasets and Namelists" on configuration.rst. What we originally planned to cover in that sub-section will eventually be covered in what's now Chapter 7. Customization. Other than those two tweaks I think it looks great, @JohnHalleyGotway! There's still more to update and fill out in the coming months, but this overhaul and reorg of the documentation is a HUGE improvement.

@JohnHalleyGotway
Copy link
Contributor Author

@jaredalee I'm re-requesting your review after making the 2 changes you requested.

GitHub doesn't want me to merge until you actually select the "Approve" option.

Copy link
Contributor

@jaredalee jaredalee left a comment

Choose a reason for hiding this comment

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

Looks good. Thanks!

@JohnHalleyGotway JohnHalleyGotway merged commit 139fb36 into main Aug 6, 2025
3 checks passed
@JohnHalleyGotway JohnHalleyGotway mentioned this pull request Aug 6, 2025
13 tasks
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.

Reorganize User's Guide content
2 participants