framework
framework copied to clipboard
docs: Guide / Dir Structure / Composables / Notice how composables can break
🔗 Linked issue
❓ Type of change
- [x] 📖 Documentation (updates to the documentation or readme)
- [ ] 🐞 Bug fix (a non-breaking change that fixes an issue)
- [ ] 👌 Enhancement (improving an existing functionality like performance)
- [ ] ✨ New feature (a non-breaking change that adds functionality)
- [ ] ⚠️ Breaking change (fix or feature that would cause existing functionality to change)
📚 Description
I think can be beneficial to notice how composables break when other composables are used in the file but outside the scope of the composable function, the error stack clue (nuxt not available) might not be enough for figuring out what is happening, and some non scope connaisseurs can have a unnecesary bad time guessing it out.
Additionally will be super nice to explain a litle bit about how Nuxt operates internally with this composables; How are them acctually "binded" to the Nuxt context ? as i suspect this is where the actual awnser inhabits.
📝 Checklist
- [ ] I have linked an issue or discussion.
- [x] I have updated the documentation accordingly.
Open in CodeSandbox Web Editor | VS Code | VS Code Insiders
Deploy Preview for nuxt3-docs ready!
Name | Link |
---|---|
Latest commit | d5d3df00a218257b8e076e895c03679dda2c63e2 |
Latest deploy log | https://app.netlify.com/sites/nuxt3-docs/deploys/6354b6702664e700095837cf |
Deploy Preview | https://deploy-preview-8116--nuxt3-docs.netlify.app |
Preview on mobile | Toggle QR Code...Use your smartphone camera to open QR code link. |
To edit notification comments on pull requests, go to your Netlify site settings.
I believe we need to document what Pooya explained on this comment: https://github.com/nuxt/nuxt.js/issues/14269
Is it more clear for you?
I believe we need to document what Pooya explained on this comment: #5740 (comment)
Is it more clear for you?
I think that explanation really deserves it's own page on the docs, maybe could be added to a new internals section. A better understanding of the tool would be super beneficial when problems happen in weird ways, i have tried to parse the source but man, I really need to learn more Javascript to get it on my own 😂
Thank you so much, and sorry for the long time to review properly. You can track future improvements to this section via nuxt/nuxt#14723.
Thanks this was fun. I think you nailed the explanation I was looking for, hope it helps other devs to.