[BUG] Correct broken guide links in theme definitions table - #483
Conversation
Theme guide links used relative paths like ./addresses, resolving to dead links (e.g. /addresses) instead of the actual guide URLs under /guides/. Fixed all six theme guide links (Addresses, Base, Buildings, Divisions, Places, Transportation). Signed-off-by: Adam Lastowka <adamlastowka@gmail.com>
Alex Iannicelli (atiannicelli)
left a comment
There was a problem hiding this comment.
oops
Super-linter summary
All files and directories linted successfully For more information, see the GitHub Actions workflow run Powered by Super-linter |
🗺️ OMF Docs previews are live!
Auto-gen schema site is now available. This is an early preview of a future workflow where we will automatically generate and publish reference docs for the Overture Maps Format schema. The auto-gen schema site may contain incomplete or inaccurate information as we are still refining the generation process, so please compare against the repo schema site and refer to the official Overture documentation for authoritative information. Note ♻️ This preview updates automatically with each push to this PR. |
There was a problem hiding this comment.
Pull request overview
This PR updates the theme definitions table’s in-page data so each theme’s “Open the … guide” link points at the correct guide location under /guides/, addressing broken navigation reported in #482.
Changes:
- Updated 6 theme
guidelink values (Addresses, Base, Buildings, Divisions, Places, Transportation) to point to guide pages under/guides/.
Suppressed comments (5)
static/theme-definitions-table.html:240
- These guide URLs are absolute (start with
/), which bypasses DocusaurusbaseUrl(configurable viaDOCUSAURUS_BASE_URL). If the site is served under a non-root baseUrl (e.g./docs/), this link will incorrectly resolve to/guides/...instead of<baseUrl>/guides/.... Prefer a relative./guides/.../path like the existing “Back to Guides” link.
"guide": "/guides/base/",
static/theme-definitions-table.html:336
- These guide URLs are absolute (start with
/), which bypasses DocusaurusbaseUrl(configurable viaDOCUSAURUS_BASE_URL). If the site is served under a non-root baseUrl (e.g./docs/), this link will incorrectly resolve to/guides/...instead of<baseUrl>/guides/.... Prefer a relative./guides/.../path like the existing “Back to Guides” link.
"guide": "/guides/buildings/",
static/theme-definitions-table.html:476
- These guide URLs are absolute (start with
/), which bypasses DocusaurusbaseUrl(configurable viaDOCUSAURUS_BASE_URL). If the site is served under a non-root baseUrl (e.g./docs/), this link will incorrectly resolve to/guides/...instead of<baseUrl>/guides/.... Prefer a relative./guides/.../path like the existing “Back to Guides” link.
"guide": "/guides/divisions/",
static/theme-definitions-table.html:568
- These guide URLs are absolute (start with
/), which bypasses DocusaurusbaseUrl(configurable viaDOCUSAURUS_BASE_URL). If the site is served under a non-root baseUrl (e.g./docs/), this link will incorrectly resolve to/guides/...instead of<baseUrl>/guides/.... Prefer a relative./guides/.../path like the existing “Back to Guides” link.
"guide": "/guides/places/",
static/theme-definitions-table.html:696
- These guide URLs are absolute (start with
/), which bypasses DocusaurusbaseUrl(configurable viaDOCUSAURUS_BASE_URL). If the site is served under a non-root baseUrl (e.g./docs/), this link will incorrectly resolve to/guides/...instead of<baseUrl>/guides/.... Prefer a relative./guides/.../path like the existing “Back to Guides” link.
"guide": "/guides/transportation/",
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Absolute paths (/guides/...) bypass the Docusaurus baseUrl and break under a non-root DOCUSAURUS_BASE_URL. Switch to relative paths (./guides/...) consistent with the existing back-link. Signed-off-by: Adam Lastowka <adamlastowka@gmail.com>
Closes #482
Theme guide links used relative paths like ./addresses, resolving to dead links (e.g. /addresses) instead of the actual guide URLs under /guides/. Fixed all six theme guide links (Addresses, Base, Buildings, Divisions, Places, Transportation).