docs: add migration guide from connect to connect-next#1
Conversation
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request introduces a new migration guide to assist users in transitioning their projects from the older Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Changelog
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Code Review
This pull request adds a helpful migration guide to the README.md for users moving from connect to connect-next. The instructions are clear and cover dependency changes and import updates. I've suggested one improvement to make the guide more comprehensive by including instructions for other popular package managers like yarn and pnpm.
Note: Security Review has been skipped due to the limited scope of the PR.
There was a problem hiding this comment.
Pull request overview
Adds a short migration guide to help users move from the legacy connect package to connect-next, aligning installation and import patterns with the fork’s ESM + bundled-types setup.
Changes:
- Document uninstalling
connectand@types/connect, then installingconnect-next. - Call out that
connect-nextincludes its own TypeScript types. - Document the import change from a default
connectimport to a named{ connect }export.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Add instructions for migrating from the
connectpackage to the newconnect-nextpackage. Include steps for removing old dependencies, installing the new package, and updating imports. Also mention that TypeScript types are now included in the package.