Repository navigation
Add project logo (README, docs header/favicon, landing pages); fix asset URLs 404 on Pages - #1
Merged
Merged
Conversation
Root-absolute asset links (/assets/...) are left as-is by MkDocs, but the site is served under /FortranCallJulia/, so they 404 in production: every figure in the zh annex, and the interactive architecture iframe plus its static fallback on both locales. The local T3 preview served at the domain root, which masked this during the docs-tree QA. Switch to relative links, which MkDocs resolves per rendered page.
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.
What
Adds the project logo (user-provided artwork) and wires it everywhere a
reader meets the project:
theme.logo(square badge crop) on every pageen/index.mdandzh/index.mdAssets:
docs/assets/logo.png(251×137 original),logo-square.png(113×113 tight crop around the badge),
favicon.png(48×48). All derivedfrom the same source image; the square crops exist because a wide banner
squashes when used as a favicon/nav logo.
Fixed along the way: root-absolute asset URLs 404 in production
While wiring the logo I found that MkDocs leaves root-absolute links
(
/assets/...) untouched, but the site is served under/FortranCallJulia/— so on the live site today, every figure in thezh figures annex and the interactive architecture iframe (plus its static
fallback) on both locales are broken:
https://openearthmodelling.github.io/assets/figs/fig1_sod_transport.png→ 404architecture-preview.png,fcj-architecture.htmlRoot cause: the docs-tree QA ran on a local preview served at the domain
root, where
/assets/...resolves correctly. This PR switches all of themto relative links, which MkDocs resolves per rendered page depth.
Verification
mkdocs build --strict— exit 0, no warningsscripts/docs_parity.py— OK: 19 paired, 2 exempt, 40 pages + 1 assetpytest tests/— 10 passed(would have caught the original 404)