Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Internal links in docs reload page #1592

Closed
orvn opened this issue Jun 28, 2022 · 0 comments · Fixed by #1559
Closed

Internal links in docs reload page #1592

orvn opened this issue Jun 28, 2022 · 0 comments · Fixed by #1559
Assignees
Labels
kind/bug A bug in existing code (including security flaws) P2 Medium: Good to have, but can wait until someone steps up stack/website

Comments

@orvn
Copy link
Contributor

orvn commented Jun 28, 2022

Current behavior

A variety of links in the /docs section of the website were corrected in #1524. However, in using the absolute path format (/docs/foo), all internal links within docs cause the browser to handle routing, and therefore refresh the page.

Expected behavior

When links on the /docs section of the site are internal (the destination is within the Next app), the Next router should handle navigation virtually. The app should not refresh.

Requirements

  • To solve this, the link component should be used rather than the traditional <a> element
  • The markdown formatting should be preserved, i.e., the [link](url) format should still work in the markdown files for the docs
@orvn orvn added kind/bug A bug in existing code (including security flaws) P2 Medium: Good to have, but can wait until someone steps up stack/website labels Jun 28, 2022
@orvn orvn linked a pull request Jun 28, 2022 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/bug A bug in existing code (including security flaws) P2 Medium: Good to have, but can wait until someone steps up stack/website
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants