feat: document migration steps and enhance useAsyncQuery API in Nuxt
#6
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Add detailed **Migration Guide** to docs, including steps to switch from `@vue/apollo-composable` to `@vue3-apollo/core`. - Enhance `useAsyncQuery` with improved types, detailed JSDoc annotations, and examples for better developer experience. - Update the documentation navigation to include the new "Migration" section.
There was a problem hiding this comment.
Pull Request Overview
This PR enhances the Vue3 Apollo library by adding comprehensive migration documentation and improving the useAsyncQuery API. The changes help developers transition from @vue/apollo-composable to @vue3-apollo/core while providing better developer experience through enhanced type safety and documentation.
- Added detailed migration guide with step-by-step instructions for upgrading from
@vue/apollo-composable - Enhanced
useAsyncQuerycomposable with comprehensive JSDoc documentation, improved type definitions, and usage examples - Updated documentation navigation to include the new Migration section
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| packages/nuxt/src/runtime/composables/useAsyncQuery.ts | Added comprehensive JSDoc documentation and type annotations for better developer experience |
| packages/docs/migration.md | Created detailed migration guide covering upgrade steps, API changes, and examples |
| packages/docs/.vitepress/config.ts | Added Migration section to documentation navigation |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
@vue/apollo-composableto@vue3-apollo/core.useAsyncQuerywith improved types, detailed JSDoc annotations, and examples for better developer experience.