fix(docs): correct iframe path for embedded 3-D twins#70
Open
harsh-pandhe wants to merge 1 commit into
Open
Conversation
mkdocs use_directory_urls renders the page at /case_studies/<slug>/ but the twin.html lives at /case_studies/<slug>_outputs/twin.html — one level up. The iframe src was <slug>_outputs/twin.html, which resolved to /case_studies/<slug>/<slug>_outputs/twin.html and 404'd. Prefix with ../ so the path resolves correctly on all 12 case-study pages.
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
1 participant
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 case-study pages embed the interactive 3-D twin via
<iframe src="<slug>_outputs/twin.html">. With mkdocs's defaultuse_directory_urls: true, the page lives at/case_studies/<slug>/but the twin is at/case_studies/<slug>_outputs/twin.html— one level up. The relative path resolved to/case_studies/<slug>/<slug>_outputs/twin.htmland 404'd.Prefix with
../on all 12 pages.Why
Surfaced during the pre-demo smoke test — the 3-D twin failed to load on every case-study page. The browser even helpfully recursed back into the mkdocs app inside the iframe.
Test plan
mkdocs buildsucceeds/case_studies/ngong_ping_360/and confirm the twin renders inline