-
-
Notifications
You must be signed in to change notification settings - Fork 1.5k
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
[i18nIgnore] Remove Vue TypeScript troubleshooting section #2276
Conversation
✅ Deploy Preview for astro-docs-2 ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @bluwy! Going to “request changes” just to make some red UI scare us away from merging accidentally before v2 is released. No actual changes needed.
Will also add an en-only
keyword to the PR name — this means our i18n tracker (#438) will ignore this commit and leave the translations in their current “needs updating” state instead of marking them as up-to-date. (Another case where I wish we had a i18nIgnore
keyword instead!)
@delucis I think this can be merged now? Upstream PR is merged and released. |
Hmm. Interesting question. At the moment most users will still be on a 1.x version, so I wonder in this case if it makes sense to only remove once we actually release 2.0 to stable not just beta. General principle I’m thinking:
What do you think? |
Makes sense! And, if a problem simply isn't going to come up in v2, then there's less danger having "advice for when this happens" there, because no one will read it! ;) We could update (rather than remove the thing entirely) with a note saying that upgrading to v2 (even beta) is a solution, as this problem is fixed in v2? |
I think the only thing tying this change is that Astro 1.0 would have a hardcoded link to this section of the docs. In Astro 2.0, the link is removed so the docs can be removed as well. The fix for the section is to upgrade Volar (VSCode extension), and given most extension auto-updates, it could also be safe to remove this section early if needed 🤔 |
So currently if a user runs into this, they would be shown a link to this section of the docs? That would make me lean towards remove later rather than earlier. Unless you’re saying that most people will already have upgraded Volar so this error is probably already rare? |
Ah I miss this notification. Yeah they would be shown the old link, but only if they try to integrate Vue and and a JSX framework. Plus yes that Volar should already be upgraded to latest for most users so they shouldn't have an issue with it today. So I think this is a pretty rare case. |
Cool, sounds reasonably safe then to merge when you want. |
What kind of changes does this PR include?
Description
Reflects the upcoming breaking change in withastro/astro#5724. The troubleshooting section isn't an issue anymore as it has been fixed by Volar.
I also removed it for the translated docs.