-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
feat(nuxt): Improve docs based on feedback #12002
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
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
2 Skipped Deployments
|
Bundle ReportChanges will decrease total bundle size by 15 bytes (-0.0%) ⬇️. This is within the configured threshold ✅ Detailed changes
|
| </Expandable> | ||
| <Expandable permalink title="pnpm: Resolving 'import-in-the-middle' external package errors"> | ||
| <Expandable title="pnpm dev: Cannot find package 'import-in-the-middle'"> |
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.
q: Is this only an issue for pnpm dev?
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.
Yes, only in dev mode. Just tested it and building and running the build output works with pnpm
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.
Hm ok, I wonder if we then should even bother with installing iitm in the wizard flow (getsentry/sentry-wizard#727)
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.
I think it's fine to install it, people will probably want to run Sentry in the dev mode as well. What about changing the prompt to something like this "To run Sentry in pnpm dev, 'import-in-the-middle' needs to be installed."
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.
+1 to devs wanting to run Sentry in dev mode.
| ``` | ||
|
|
||
| This step is necessary because Nuxt sets default values for source maps ([Nuxt docs](https://nuxt.com/docs/api/nuxt-config#sourcemap)), and the Sentry Nuxt Module keeps these settings when they are explicitly defined. | ||
| The option `'hidden'` works like `true`, but suppresses the source map reference comments that would be added to the end of each generated file in the build output. |
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.
m: I'd add a reason for why we want hidden over true, otherwise this info is just repeating someone else's docs.
lizokm
left a comment
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 for adding! I left some language suggestions :)
* feat(nuxt): Improve docs based on feedback * add tilde * add 'hidden' explanation * delete org and project from wizard * fix formatting * liza review suggestions

DESCRIBE YOUR PR
Improves some sections of the docs based on feedback from @whitep4nth3r
IS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs to go live.
SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes: