Skip to content

docs: fix broken relative links in static analysis and tutorials pages - #3128

Open
imitater-dou wants to merge 1 commit into
crytic:masterfrom
imitater-dou:docs/fix-mdbook-relative-links
Open

imitater-dou wants to merge 1 commit into
crytic:masterfrom
imitater-dou:docs/fix-mdbook-relative-links

Conversation

@imitater-dou

Copy link
Copy Markdown

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.md links to ./detectors/Detector-Documentation.md twice (Incorrect ERC20 interface, dangerous strict equality). From docs/src/api/ that resolves to docs/src/api/detectors/..., which doesn't exist; the detector docs live at docs/src/detectors/Detector-Documentation.md. The neighbouring "State variable shadowing" link on line 79 already uses the correct ../detectors/... form.
  • docs/src/tutorials/README.md links to ./static_analysis.md, but that page lives at docs/src/api/static_analysis.md (see SUMMARY.md: ./api/static_analysis.md).

Fix

  • ./detectors/Detector-Documentation.md -> ../detectors/Detector-Documentation.md (2 occurrences, anchors unchanged)
  • ./static_analysis.md -> ../api/static_analysis.md

Repro

Checked against master @ 10cfd5a: resolve each link relative to its file against git ls-tree -r --name-only HEAD. The old targets are missing and the new ones exist. Docs-only change.

Signed-off-by: ADou <ikun3.1415927@gmail.com>
@CLAassistant

Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

This branch has not been deployed

No deployments
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