-
-
Notifications
You must be signed in to change notification settings - Fork 4.8k
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
docs(schema): add NuxtHooks interface documentation #18756
Conversation
Β Open in CodeSandbox Web Editor | VS Code | VS Code Insiders |
This is great work, thank you β€οΈ I'll look through and review in detail later. |
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.
This is phenomenal. Made a couple of small comments. If you could copy them across also to packages/schema/src/types/hooks.ts
that would be very kind, and just check for consistent casing on webpack, Vite, Nuxt and Nitro. I think case-police (run pnpm lint:docs
) should help with this.
(Later, we should add functionality to pull this info directly from the source so we don't have to duplicate this kind info, and so any new hook gets automatically added to docs.)
Co-authored-by: Daniel Roe <daniel@roe.dev>
@danielroe I updated the files according to your requests |
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.
Thank you! β€οΈ
π Linked issue
#13653
β Type of change
π Description
The section Nuxt Hooks (build time) is not yet complete on the live docs page, and it's wrongly marked as "OK" as commented here
This PR adds the documentation on the interface itself and on the lifecycle hooks docs page.
This PR is important to provide information about nuxt hooks and to avoid delving into the source code to understand the hooks like I did myself.
Please make sure the description I provided for each hook is correct
Thank you
π Checklist