Skip to content

Fix broken relative links in README files - #2083

Merged
ericspod merged 1 commit into
Project-MONAI:mainfrom
pratikgx:fix-readme-links
Oct 12, 2026
Merged

ericspod merged 1 commit into
Project-MONAI:mainfrom
pratikgx:fix-readme-links

Conversation

@pratikgx

@pratikgx pratikgx commented Oct 12, 2026 •

Copy link
Copy Markdown
Contributor

Fixes # .

Description

Fixes five relative links in README files that point to paths that do not exist on main:

  • README.md: the vista3d entry pointed to ./3d_segmentation/vista3d; the tutorial moved to ./vista_3d in Update label dict #1835.
  • generation/README.md: the classifier guidance link was missing the anomaly_detection/ folder (the heading line above already uses the right path), and the diffusion autoencoder link used 2d_diffusion_autoencoder.ipynb instead of 2d_diffusion_autoencoder_tutorial.ipynb.
  • monailabel/README.md: the lung nodule detection link was missing the monailabel_ prefix of monailabel_monaibundle_3dslicer_lung_nodule_detection.ipynb.
  • deepedit/ignite/README.md: the DeepEdit Inference link pointed to ./inference.ipynb; the notebook in that folder is infoANDinference.ipynb.

Docs-only change, no notebooks touched.

Checks

  • Avoid including large-size files in the PR.
  • For security purposes, please check the contents and remove any sensitive info such as user names and private key.
  • Ensure (1) hyperlinks and markdown anchors are working (2) use relative paths for tutorial repo files (3) put figure and graphs in the ./figure folder

Summary by CodeRabbit

  • Documentation
    • Updated README links for the Vista3D notebook and DeepEdit inference guide.
    • Corrected links to the anomaly-detection classifier-free-guidance and semantic-encoder tutorials.
    • Updated the MONAIBUNDLE lung nodule detection tutorial link. These changes help readers navigate to the referenced notebook and tutorial pages.

- README.md: vista3d tutorial moved from 3d_segmentation/vista3d to
  vista_3d in Project-MONAI#1835
- generation/README.md: classifier guidance notebook lives under
  anomaly_detection/, and the diffusion autoencoder notebook is named
  2d_diffusion_autoencoder_tutorial.ipynb
- monailabel/README.md: lung nodule notebook has the monailabel_ prefix
- deepedit/ignite/README.md: inference notebook is infoANDinference.ipynb

Signed-off-by: Pratik Gandhi <travpreneur@gmail.com>
@coderabbitai

coderabbitai Bot commented Oct 12, 2026 •

Copy link
Copy Markdown

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: d0814c22-58fb-4c43-9c57-b3d43a290e6e

📥 Commits

Reviewing files that changed from the base of the PR and between b4b61f8 and 4ecfada.


📒 Files selected for processing (4)
  • README.md
  • deepedit/ignite/README.md
  • generation/README.md
  • monailabel/README.md

Included review availability: This review used your included allowance. Your plan provides up to 8 included reviews per hour; 7 remain after this review.



Walkthrough

Four README files now link to tutorials using updated paths or filenames.

Changes

Tutorial README links

Layer / File(s) Summary
Update tutorial link targets
README.md, deepedit/ignite/README.md, generation/README.md, monailabel/README.md
Five tutorial links now use updated paths or filenames.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~3 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to 4ecfa

The updated README links point to existing tutorial destinations; no actionable merge risk remains.

Pre-merge checks | Passed 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check Passed The title clearly and concisely describes the main change: fixing broken relative links in README files.
Description check Passed The description explains all link updates, identifies the affected files, and states that the change is documentation-only. The Checks section covers the applicable items. The issue reference remains …
Docstring Coverage Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create a new PR


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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@ericspod ericspod left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Hi @pratikgx thanks for these fixes, looks good to me.

@ericspod
ericspod merged commit 312ae90 into Project-MONAI:main Oct 12, 2026
7 checks passed
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.

2 participants