docs: fix stale documentation links and placeholders#5700
Conversation
The Paddle multi-task freezing section in doc/freeze/freeze.md linked to ../train/multi-task-training-pd.md, which does not exist; point it at the existing ../train/multi-task-training.md (as the PyTorch section already does). doc/model/train-se-a-mask.md carried an unfinished "[DP/MM](left to be filled)" placeholder; drop the placeholder link markup since no citation target is available. Fix deepmodeling#5695
📝 WalkthroughWalkthroughTwo documentation files were updated with minor text corrections: a stale relative link in the Paddle freeze multi-task documentation was fixed, and a placeholder citation in the se_a_mask training documentation was replaced with direct text. ChangesDocumentation link fixes
Estimated code review effort: 1 (Trivial) | ~2 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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 |
There was a problem hiding this comment.
🧹 Nitpick comments (2)
doc/model/train-se-a-mask.md (1)
71-71: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winAcceptable fix for placeholder, but consider adding the actual citation URL if available.
Removing the broken
[DP/MM](left to be filled)placeholder markup is the right call per the issue suggestion. If the DP/MM paper has a known DOI or arXiv URL, consider linking it directly (e.g.,[DP/MM paper](https://arxiv.org/abs/XXXX.XXXXX)or similar) rather than leaving an unlinked plain-text reference. If the target is not yet determined, the current plain text is fine.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@doc/model/train-se-a-mask.md` at line 71, The DP/MM reference is still a placeholder-style mention, so update the documentation text around the selection of specific atoms to remove any broken link markup and, if the paper’s DOI or arXiv URL is known, turn the DP/MM mention into a real citation link; otherwise keep it as plain text. Use the existing DP/MM paper reference in the train-se-a-mask documentation as the anchor for the change.doc/freeze/freeze.md (1)
26-26: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low valueLink fix is correct, but consider aligning extension usage with PyTorch tab.
The corrected link target
../train/multi-task-training.mdexists and is the right destination. However, the PyTorch tab on Line 26 uses../train/multi-task-trainingwithout the.mdextension, while the Paddle tab now uses../train/multi-task-training.md. For consistency across tabs referencing the same document, consider aligning both to use the same format (preferably with.mdto match cross-file conventions as seen indoc/model/dpa2.md).Also applies to: 44-44
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@doc/freeze/freeze.md` at line 26, The multi-task training link is now correct, but the PyTorch and Paddle tab references in freeze.md should use the same target format for consistency. Update the multi-task-training link used by the relevant tab content in the freeze document so both tabs reference the same destination style, preferably with the .md extension, and keep the change aligned with the existing link patterns used by other docs such as the multi-task training references.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@doc/freeze/freeze.md`:
- Line 26: The multi-task training link is now correct, but the PyTorch and
Paddle tab references in freeze.md should use the same target format for
consistency. Update the multi-task-training link used by the relevant tab
content in the freeze document so both tabs reference the same destination
style, preferably with the .md extension, and keep the change aligned with the
existing link patterns used by other docs such as the multi-task training
references.
In `@doc/model/train-se-a-mask.md`:
- Line 71: The DP/MM reference is still a placeholder-style mention, so update
the documentation text around the selection of specific atoms to remove any
broken link markup and, if the paper’s DOI or arXiv URL is known, turn the DP/MM
mention into a real citation link; otherwise keep it as plain text. Use the
existing DP/MM paper reference in the train-se-a-mask documentation as the
anchor for the change.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro
Run ID: b31b6081-6e9d-40fe-9ce9-892c171aa360
📒 Files selected for processing (2)
doc/freeze/freeze.mddoc/model/train-se-a-mask.md
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #5700 +/- ##
==========================================
- Coverage 81.97% 81.78% -0.19%
==========================================
Files 959 959
Lines 105748 105747 -1
Branches 4102 4104 +2
==========================================
- Hits 86684 86483 -201
- Misses 17573 17768 +195
- Partials 1491 1496 +5 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Problem
Two documentation references were stale:
doc/freeze/freeze.mdlinked the Paddle multi-task freezing text to../train/multi-task-training-pd.md, which does not exist in the checkout (only../train/multi-task-training.mdis present). The PyTorch section of the same file already links to../train/multi-task-training.doc/model/train-se-a-mask.mdcontained an unfinished placeholder link,[DP/MM](left to be filled).Fix
../train/multi-task-training.md.[DP/MM](left to be filled)placeholder markup, since no citation target is available, leaving plain text.Note on the third item
The original issue also flagged
doc/getting-started/install.mdlinking toinstall-from-source.md. That one is not a bug:doc/getting-started/install.mdis a symlink to../install/easy-install.md, and the[build from source](install-from-source.md)link is correct relative to that file's real location underdoc/install/, whereinstall-from-source.mdexists. It is left unchanged.Test
These are documentation link fixes. There is no docs linkcheck in CI, and Sphinx/MyST do not fail the build on broken relative Markdown links, which is why these went unnoticed. A linkcheck is intentionally not added here: the docs use MyST extensionless cross-references (e.g. the sibling
../train/multi-task-traininglink in the same file), so a naive relative-file-existence validator would produce false positives; a robust linkcheck is a separate infrastructure change out of scope for this fix. The fix is verified by confirming the corrected link target exists and the placeholder is removed.Fix #5695
Summary by CodeRabbit
se_a_maskguide with a clearer reference to the relevant DP/MM paper.