base-org / web

https://base.org
Apache License 2.0
269 stars 398 forks source link

Docs Request: Fix Relative URL Path Resolution in Production Environment in Linked Minting Frame #353

Closed twynne20 closed 8 months ago

twynne20 commented 8 months ago

What is the issue you are encountering with the docs?

In the production environment of the documentation site (https://docs.base.org/), relative links that are supposed to navigate within the guides section are incorrectly appending to the current path instead of navigating relative to the current directory level. This behavior is inconsistent with the local development environment, where the same relative links function correctly.

For example, a link defined as [advanced behavior]: ./advanced-frame-behavior in the markdown files correctly resolves to http://localhost:3000/building-with-base/guides/advanced-frame-behavior locally, but leads to an incorrect URL https://docs.base.org/building-with-base/guides/linked-minting-frame/advanced-frame-behavior in production, creating a 404 error since the page does not exist at the nested path.

Links to Impacted Docs

Describe the solution you'd like to see.

I would like the relative links in the documentation to resolve consistently between the local development environment and the production environment. This may involve ensuring that the documentation site's URL routing and base paths are correctly configured to interpret relative paths correctly. Alternatively, converting relative paths to root-relative paths (starting with /) might be a solution to ensure consistent behavior across environments.

Additional context

This issue leads to a poorer user experience, as readers encounter 404 errors when attempting to navigate the documentation. It could be beneficial to review the site's routing configurations or the static site generator's settings to identify and rectify the discrepancy between local and production URL resolutions. image

twynne20 commented 8 months ago

PR Created: #354

twynne20 commented 8 months ago

Added another commit on the PR adding broken links in linked-minting-frame.md:

Assumed Frame was pointing here, but you all might want to verify that!