Repository navigation
docs: fix broken relative links in static analysis and tutorials pages - #3128
Open
imitater-dou wants to merge 1 commit into
Open
imitater-dou wants to merge 1 commit into
imitater-dou wants to merge 1 commit into
Conversation
Signed-off-by: ADou <ikun3.1415927@gmail.com>
|
|
This branch has not been deployed
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.
Three relative links in the mdBook sources point to files that don't exist, so they 404 on GitHub and in the rendered book.
Root Cause
docs/src/api/static_analysis.mdlinks to./detectors/Detector-Documentation.mdtwice (Incorrect ERC20 interface, dangerous strict equality). Fromdocs/src/api/that resolves todocs/src/api/detectors/..., which doesn't exist; the detector docs live atdocs/src/detectors/Detector-Documentation.md. The neighbouring "State variable shadowing" link on line 79 already uses the correct../detectors/...form.docs/src/tutorials/README.mdlinks to./static_analysis.md, but that page lives atdocs/src/api/static_analysis.md(seeSUMMARY.md:./api/static_analysis.md).Fix
./detectors/Detector-Documentation.md->../detectors/Detector-Documentation.md(2 occurrences, anchors unchanged)./static_analysis.md->../api/static_analysis.mdRepro
Checked against
master@ 10cfd5a: resolve each link relative to its file againstgit ls-tree -r --name-only HEAD. The old targets are missing and the new ones exist. Docs-only change.