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

feat: add section about issues with navigation to known issues #198

Merged
merged 4 commits into from
Aug 1, 2024

Conversation

hirasso
Copy link
Member

@hirasso hirasso commented Aug 1, 2024

Description

  • Add a section about issues with navigation to "Known Issues"
  • Rename "Kown Issues" to "Kown Issues & Troubleshooting" for easier discovery through search

Direct link to preview deploy: https://deploy-preview-198--splendorous-kataifi-9ae281.netlify.app/getting-started/common-issues/#the-browser-performs-a-hard-visit-instead-of-a-swup-transition

Checks

  • The PR is submitted to the master branch
  • The code was linted before pushing (npm run lint)

@hirasso hirasso requested a review from daun August 1, 2024 10:32
Copy link

netlify bot commented Aug 1, 2024

Deploy Preview for splendorous-kataifi-9ae281 ready!

Name Link
🔨 Latest commit b2dc2ec
🔍 Latest deploy log https://app.netlify.com/sites/splendorous-kataifi-9ae281/deploys/66ab7fd9a3443d0008d115ce
😎 Deploy Preview https://deploy-preview-198--splendorous-kataifi-9ae281.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@daun
Copy link
Member

daun commented Aug 1, 2024

Great idea.

I would slightly rephrase the first bullet point — maybe "One of the containers is missing in the old or new page" is a bit more to the point than "mismatch" in my opinion. And should we add a note about installing the debug plugin to this bullet point as well? We could add a check there that warns about missing containers directly on load to prevent the error being swallowed by the hard page load. Happy to do that :)

@hirasso
Copy link
Member Author

hirasso commented Aug 1, 2024

I never found the debug plugin to be the most useful TBH... but it wouldn't hurt to add a reference to it somewhere along the lines here I guess. Would you like to push directly to this PR? :)

@daun
Copy link
Member

daun commented Aug 1, 2024

Alright, added a note about debug plugin, and a link to the devtools manual on the preserve-log option. Couldn't help it and simplified the wording here and there, feel free to revert if it distorts what you were trying to say.

Ready to go from my end :)

@hirasso
Copy link
Member Author

hirasso commented Aug 1, 2024

🤝

@hirasso hirasso merged commit 3554258 into master Aug 1, 2024
5 checks passed
@daun
Copy link
Member

daun commented Aug 1, 2024

@hirasso I've added some more checks to the debug plugin to make it actually useful for newcomers.

@daun daun deleted the feat/add-common-issues branch September 25, 2024 18:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants