Release 1.6 Doc Updates#8882
Conversation
Signed-off-by: Eric Kerfoot <17726042+ericspod@users.noreply.github.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughThis PR prepares MONAI for the 1.6.0 release. It adds a new versioned changelog entry populated with "Added", "Fixed", "Changed" subsections and PR references; updates the citation metadata to version 1.6.0; introduces a comprehensive whatsnew_1_6.md document covering new losses, metrics, config enhancements, and serialization changes; and registers the new release notes in the documentation index. In parallel, it consolidates all documentation links across README, CONTRIBUTING, and Sphinx config from docs.monai.io to monai.readthedocs.io. A minor formatting cleanup removes emojis from the prior 1.5.2 release notes header. Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Signed-off-by: Eric Kerfoot <17726042+ericspod@users.noreply.github.com>
for more information, see https://pre-commit.ci
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/source/whatsnew_1_6.md`:
- Line 17: Update the sentence in the release notes where it currently reads
"which is not out of support" to instead read "which is now out of support" so
the phrasing in the MONAI what's new text (the sentence mentioning Python 3.10
and 3.9) is grammatically correct; edit the string in
docs/source/whatsnew_1_6.md that contains that sentence accordingly.
- Line 27: Fix the typo in the release note sentence that mentions re-enabling
pickle: replace "equivaent" with "equivalent" in the sentence that references
the environment variable MONAI_ALLOW_PICKLE so it reads "...or the equivalent
true value." Ensure the corrected word appears in the same paragraph where
"MONAI_ALLOW_PICKLE" and "pickle" are discussed.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 09afe289-b05b-4763-b7eb-0e1e6a0c7248
📒 Files selected for processing (8)
CHANGELOG.mdCITATION.cffCONTRIBUTING.mdREADME.mddocs/source/index.rstdocs/source/whatsnew.rstdocs/source/whatsnew_1_5_2.mddocs/source/whatsnew_1_6.md
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Signed-off-by: Eric Kerfoot <17726042+ericspod@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Signed-off-by: Eric Kerfoot <17726042+ericspod@users.noreply.github.com>
garciadias
left a comment
There was a problem hiding this comment.
URL change from docs.monai.io to monai.readthedocs.io across multiple files (README.md, CONTRIBUTING.md, docs/source/index.rst). Please verify that docs.monai.io is set up to redirect to the new URL, otherwise users with existing bookmarks will lose access.
|
We can't change anything on monai.io currently so there's no way of redirecting. |
Signed-off-by: Eric Kerfoot <17726042+ericspod@users.noreply.github.com>
Signed-off-by: Eric Kerfoot <17726042+ericspod@users.noreply.github.com>
Part of #8874
Description
This updates documentation and other components for the 1.6.0 release.
Types of changes
./runtests.sh -f -u --net --coverage../runtests.sh --quick --unittests --disttests.make htmlcommand in thedocs/folder.