Update links for MONAI website and docs
Update links for MONAI website and docs
Summary by CodeRabbit
-
Documentation
- Updated documentation reference links across multiple README files to point to the new documentation host.
- Updated external resource links for Model Zoo and network architecture references to reflect new URLs.
βοΈ Tip: You can customize this high-level summary in your review settings.
Walkthrough
Four README files updated with redirected documentation URLs. Primary change redirects references from various sources (docs.monai.io, monai.io/model-zoo) to monai.readthedocs.io stable pages and project-monai.github.io. No functional code alterations.
Changes
| Cohort / File(s) | Summary |
|---|---|
Documentation link redirects README.md |
Documentation Status badge URL and multiple installation/resource links redirected from docs.monai.io to monai.readthedocs.io; Slack, Website, and API documentation URLs updated |
Network reference URL updates sample-apps/endoscopy/README.md |
BasicUNet, FlexibleUNet, and SEResNet50 model links updated to point to monai.readthedocs.io stable documentation pages |
Bundle specification URL update sample-apps/monaibundle/README.md |
MONAI Bundle Specification reference URL updated from docs domain to monai.readthedocs.io stable |
Model Zoo and network URLs sample-apps/radiology/README.md |
MONAI Model Zoo URL redirected to project-monai.github.io; DynUNet, UNETR, BasicUNet, and UNet network reference URLs updated to monai.readthedocs.io/en/stable/networks.html |
Estimated code review effort
π― 1 (Trivial) | β±οΈ ~3 minutes
- All changes are documentation-only URL redirects with no functional logic modifications
- Consistent pattern applied across all files (straightforward link target replacements)
- No API or code structure changes
Poem
A rabbit hops through links so fine,
Redirecting each URL line,
From old domains to readthedocs bright,
Documentation now shines clear and right! π°β¨
Pre-merge checks and finishing touches
β Passed checks (3 passed)
| Check name | Status | Explanation |
|---|---|---|
| Description Check | β Passed | Check skipped - CodeRabbitβs high-level summary is enabled. |
| Title check | β Passed | The title accurately summarizes the main change: updating documentation and website links across multiple README files to point to new MONAI documentation hosts. |
| Docstring Coverage | β Passed | No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. |
β¨ Finishing touches
π§ͺ Generate unit tests (beta)
- [ ] Create PR with unit tests
- [ ] Post copyable unit tests in a comment
- [ ] Commit unit tests in branch
update_links
[!TIP]
π Customizable high-level summaries are now available in beta!
You can now customize how CodeRabbit generates the high-level summary in your pull requests β including its content, structure, tone, and formatting.
- Provide your own instructions using the
high_level_summary_instructionssetting.- Format the summary however you like (bullet lists, tables, multi-section layouts, contributor stats, etc.).
- Use
high_level_summary_in_walkthroughto move the summary from the description to the walkthrough section.Example instruction:
"Divide the high-level summary into five sections:
- π Description β Summarize the main change in 50β60 words, explaining what was done.
- π References β List relevant issues, discussions, documentation, or related PRs.
- π¦ Dependencies & Requirements β Mention any new/updated dependencies, environment variable changes, or configuration updates.
- π Contributor Summary β Include a Markdown table showing contributions:
| Contributor | Lines Added | Lines Removed | Files Changed |- βοΈ Additional Notes β Add any extra reviewer context. Keep each section concise (under 200 words) and use bullet or numbered lists for clarity."
Note: This feature is currently in beta for Pro-tier users, and pricing will be announced later.
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 @coderabbitai help to get the list of available commands and usage tips.
@SachidanandAlle , could you help merge this? It's update links for a few of the README files. Not sure if there is anything else that needs updating for PyPi.