-
-
Notifications
You must be signed in to change notification settings - Fork 1.8k
fix broken links in documentation #3145
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR fixes broken and outdated links throughout the DeepLabCut documentation. The changes update URLs to reflect current domain structures and remove links that are no longer valid.
Changes:
- Updated Twitter links from twitter.com to x.com domain
- Corrected documentation internal links to use proper file paths
- Fixed NVIDIA shop URL to marketplace domain
- Removed a broken external tutorial link
Reviewed changes
Copilot reviewed 13 out of 13 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| examples/COLAB/COLAB_transformer_reID.ipynb | Updated maDLC documentation links and fixed COLAB notebook filename reference |
| examples/COLAB/COLAB_YOURDATA_maDLC_TrainNetwork_VideoAnalysis.ipynb | Fixed Colab badge URL to point to correct notebook filename |
| examples/COLAB/COLAB_3miceDemo.ipynb | Updated maDLC quick guide link to correct path |
| docs/recipes/TechHardware.md | Updated NVIDIA GPU shop URL and removed broken Twitter reference |
| docs/recipes/MegaDetectorDLCLive.md | Removed broken Twitter link |
| docs/recipes/ClusteringNapari.md | Updated Twitter link to X.com |
| docs/maDLC_UserGuide.md | Updated social media links and course URL |
| docs/installation.md | Removed broken external tutorial link |
| docs/gui/napari_GUI.md | Fixed internal documentation link path |
| docs/beginner-guides/beginners-guide.md | Fixed internal documentation link with proper .html extension |
| docs/UseOverviewGuide.md | Fixed beginner guide link path |
| docs/Governance.md | Updated Twitter link to X.com |
| README.md | Updated Twitter links, course URL, and model zoo URL throughout |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Very nice ! @deruyter92 Let me know if I can do anything else for the docs next (maybe work on the dev/API docs ?)
The docs contained some broken links. The URLs are corrected (or in a few cases deleted) in this PR.