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

docs(schema): add NuxtHooks interface documentation #18756

Merged
merged 8 commits into from
Feb 5, 2023
Merged

Conversation

Draichi
Copy link
Contributor

@Draichi Draichi commented Feb 4, 2023

πŸ”— Linked issue

#13653

❓ Type of change

  • πŸ“– 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

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

  • I have linked an issue or discussion.
  • I have updated the documentation accordingly.

@codesandbox
Copy link

codesandbox bot commented Feb 4, 2023

CodeSandbox logoCodeSandbox logoΒ  Open in CodeSandbox Web Editor | VS Code | VS Code Insiders

@danielroe
Copy link
Member

This is great work, thank you ❀️

I'll look through and review in detail later.

Copy link
Member

@danielroe danielroe left a 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.)

docs/3.api/4.advanced/1.hooks.md Outdated Show resolved Hide resolved
docs/3.api/4.advanced/1.hooks.md Outdated Show resolved Hide resolved
docs/3.api/4.advanced/1.hooks.md Outdated Show resolved Hide resolved
docs/3.api/4.advanced/1.hooks.md Outdated Show resolved Hide resolved
docs/3.api/4.advanced/1.hooks.md Outdated Show resolved Hide resolved
docs/3.api/4.advanced/1.hooks.md Outdated Show resolved Hide resolved
docs/3.api/4.advanced/1.hooks.md Outdated Show resolved Hide resolved
docs/3.api/4.advanced/1.hooks.md Outdated Show resolved Hide resolved
docs/3.api/4.advanced/1.hooks.md Outdated Show resolved Hide resolved
docs/3.api/4.advanced/1.hooks.md Outdated Show resolved Hide resolved
@Draichi
Copy link
Contributor Author

Draichi commented Feb 4, 2023

@danielroe I updated the files according to your requests

Copy link
Member

@danielroe danielroe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you! ❀️

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.

None yet

2 participants