Update links for MONAI website and docs #1876
Conversation
Replace references to monai.io domain with project-monai.github.io for the website and monai.readthedocs.io for documentation.
WalkthroughFour 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
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
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.
Example instruction:
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 |
|
@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. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
sample-apps/radiology/README.md (1)
109-109: Consider adding documentation link for DynUNet.Line 109 mentions "DynUNet as the default network" but only includes a link to UNETR. Consider adding an explicit documentation link for DynUNet as well for consistency and to help users find the network specifications.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge base: Disabled due to data retention organization setting
📒 Files selected for processing (4)
README.md(4 hunks)sample-apps/endoscopy/README.md(3 hunks)sample-apps/monaibundle/README.md(1 hunks)sample-apps/radiology/README.md(6 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
sample-apps/monaibundle/README.md
17-17: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
README.md
17-17: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (17)
- GitHub Check: packaging (3.12)
- GitHub Check: packaging (3.11)
- GitHub Check: deps_check (ubuntu-latest, 3.11)
- GitHub Check: deps_check (ubuntu-latest, 3.9)
- GitHub Check: deps_check (ubuntu-latest, 3.12)
- GitHub Check: packaging (3.10)
- GitHub Check: packaging (3.9)
- GitHub Check: deps_check (windows-latest, 3.12)
- GitHub Check: deps_check (ubuntu-latest, 3.10)
- GitHub Check: deps_check (windows-latest, 3.9)
- GitHub Check: deps_check (windows-latest, 3.10)
- GitHub Check: build (3.12)
- GitHub Check: build (3.10)
- GitHub Check: deps_check (windows-latest, 3.11)
- GitHub Check: build (3.9)
- GitHub Check: build (3.11)
- GitHub Check: build-docs (3.10)
🔇 Additional comments (9)
sample-apps/monaibundle/README.md (1)
17-17: Verify the Bundle Specification URL exists at the new location.The link has been updated to the stable documentation host, but you should confirm that the Bundle Specification page is accessible at
https://monai.readthedocs.io/en/stable/mb_specification.html.sample-apps/endoscopy/README.md (1)
109-109: Verify network documentation links at the new location.Three network reference links have been updated to the stable readthedocs host:
- BasicUNet (line 109)
- FlexibleUNet (line 122)
- SEResNet50 (line 133)
Confirm these links are accessible and that the anchor fragments (#basicunet, #flexibleunet, #seresnet50) correctly match the network documentation page structure on
https://monai.readthedocs.io/en/stable/networks.html.Also applies to: 122-122, 133-133
sample-apps/radiology/README.md (2)
70-70: Verify the MONAI Model Zoo redirect.The MONAI Model Zoo URL has been updated from
https://monai.io/model-zootohttps://project-monai.github.io/model-zoo. Confirm this new URL is accessible and that it correctly hosts the model zoo content.
109-109: Verify network documentation links at the new readthedocs location.Five network reference links have been updated across the file to
https://monai.readthedocs.io/en/stable/networks.html:
- Line 109: UNETR and general networks listing
- Line 154: BasicUNet
- Line 194: UNet
- Line 245: UNet
- Line 283: UNet
Confirm these links are accessible and that anchor fragments correctly match the network documentation structure.
Also applies to: 154-154, 194-194, 245-245, 283-283
README.md (5)
17-17: Verify documentation status badge URL.The Documentation Status badge URL has been updated to point to
https://monai.readthedocs.io/projects/label/en/latest/. Confirm this badge endpoint is valid and returns the expected build status.
30-30: Verify full documentation link.The main documentation link has been updated to
https://monai.readthedocs.io/projects/label/en/latest/index.html. Confirm this URL is accessible and serves the complete MONAILabel documentation.
185-186: Verify installation documentation URLs.The Ubuntu and Windows installation links have been updated to
https://monai.readthedocs.io/projects/label/en/latest/installation.html. Confirm these URLs exist and contain the correct platform-specific installation instructions.
411-412: Verify Website and API documentation URLs.Two URLs in the Additional Resources section have been updated:
- Website: now
https://project-monai.github.io/- API documentation: now
https://monai.readthedocs.io/projects/labelConfirm both URLs are accessible and route to the correct resources.
17-417: Partial verification complete; recommend manual comprehensive audit.Initial verification of 7 critical documentation URLs passed (all returned 200 or 302 status codes). However, the README contains 43+ unique URLs, and a comprehensive test of all links could not be completed due to script limitations.
Web search confirms that MONAILabel has known documentation and README issues (e.g., the OHIF workflow documented in the README has been reported as non-functional). While the critical readthedocs links are accessible, this suggests broader documentation quality concerns beyond simple link accessibility.
Recommend manually verifying all URLs in the README or implementing a complete automated link checker, especially given the project's history of documentation issues.
| [](https://opensource.org/licenses/Apache-2.0) | ||
| [](https://github.com/Project-MONAI/MONAILabel/commits/main) | ||
| [](https://docs.monai.io/projects/label/en/latest/?badge=latest) | ||
| [](https://monai.readthedocs.io/projects/label/en/latest/?badge=latest) |
There was a problem hiding this comment.
Fix heading level hierarchy.
The static analysis flagged a heading-level mismatch at this line. Review the heading structure to ensure it increments by only one level at a time.
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
17-17: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
🤖 Prompt for AI Agents
In README.md around line 17, the badge line sits at a heading level that creates
a mismatch in the document's heading hierarchy; adjust the surrounding headings
so levels increment by only one at a time (e.g., change an H3 to H2 or H2 to H3
as appropriate) or move the badge out of the heading block so that the sequence
of headings before and after line 17 follows a single-level step difference,
ensuring consistent Markdown heading levels throughout the file.
| The MONAIBundle App allows you to easily pull any MONAI Bundle from the [MONAI Model Zoo](https://github.com/Project-MONAI/model-zoo/tree/dev/models) and import it into MONAI Label. However, it's important to note that any MONAI Bundle used with MONAI Label must meet the following constraints: | ||
|
|
||
| - It must comply with the [MONAI Bundle Specification](https://docs.monai.io/en/latest/mb_specification.html). | ||
| - It must comply with the [MONAI Bundle Specification](https://monai.readthedocs.io/en/stable/mb_specification.html). |
There was a problem hiding this comment.
Fix heading level hierarchy.
The static analysis flagged a heading-level mismatch at this line. Review the heading structure to ensure it increments by only one level at a time (e.g., h1 → h2, not h1 → h3).
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
17-17: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
🤖 Prompt for AI Agents
In sample-apps/monaibundle/README.md around line 17, the parser flagged a
heading-level mismatch at this line — ensure the heading here increments by only
one level from the previous heading. Inspect the preceding heading level and
change this heading so it is exactly one level deeper (e.g., if the previous is
h1 make this h2, if previous is h2 make this h3), updating the Markdown heading
markers accordingly so the document hierarchy is consistent.
Update links for MONAI website and docs
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.