Fix broken VAE notebook link in README.rst (#308)#469
Open
jbbqqf wants to merge 1 commit into
Open
Conversation
The BaseVAE notebook URL in README.rst pointed at `docs/notebooks/DiCE_getting_started_feasible.ipynb`, but the actual on-disk path is `docs/source/notebooks/DiCE_getting_started_feasible.ipynb`. The link has 404'd for users following the README ever since the `docs/source/` reorganisation. Adds `tests/test_readme_links.py` which scans every `https://github.com/interpretml/DiCE/blob/<ref>/<path>.ipynb` URL in README.rst and asserts it resolves to a real file in the repo. Only checks in-repo paths — no network access. This prevents future README/folder-rename drift from re-introducing 404 links. Closes interpretml#308. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The BaseVAE notebook URL in README.rst points at
docs/notebooks/DiCE_getting_started_feasible.ipynb, but the actual on-diskpath is
docs/source/notebooks/DiCE_getting_started_feasible.ipynb. As@reilankoba reported in #308, the link has been 404 for users since the
docs/source/reorganisation.Why
Two changes:
source/segment).
tests/test_readme_links.pythat scans everyhttps://github.com/interpretml/DiCE/blob/<ref>/<path>.ipynbURL inREADME.rst and asserts each path resolves to a real file under the
working tree. No network access — purely an in-repo path check. This
stops future folder renames from silently 404-ing notebook links.
Reproduce BEFORE/AFTER yourself (copy-paste)
What I ran locally
pytest tests/test_readme_links.py→ 2 passed on this branchorigin/mainREADME with the expected missing-path messageEdge cases
docs/source/notebooks/AI disclosure
This change was prepared with the assistance of Claude (Anthropic).
The author reviewed every line and is responsible for the final result.