Skip to content

Conversation

@aXenDeveloper
Copy link
Owner

Improving Documentation

Description

What?

Why?

@vercel
Copy link

vercel bot commented Nov 15, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
vitnode-docs Ready Ready Preview Comment Nov 15, 2025 8:41am

@github-actions github-actions bot added the 💡 Feature A new feature label Nov 15, 2025
@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @aXenDeveloper, 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 significantly enhances the create-vitnode utility by adding automated, context-aware README generation for new projects, improving the initial developer experience. Concurrently, it brings the entire project's dependency tree up to date with the latest versions, addressing potential security vulnerabilities and leveraging new features from updated libraries. The changes also include a more resilient approach to copying configuration files, contributing to a more stable project setup process.

Highlights

  • README Generation: Introduced a new feature within create-vitnode to automatically generate a README.md file for newly created projects. This README is dynamically tailored based on the chosen package manager and project structure (e.g., API-only, monorepo), including adjusted local host URLs.
  • Dependency Updates: Performed a comprehensive update of numerous dependencies across apps/api, apps/docs, packages/config, packages/create-vitnode-app, packages/node-cron, packages/nodemailer, packages/resend, and packages/vitnode. Key updates include drizzle-kit, hono, next-intl, react-email related packages, @types/* packages, next, @swc/core, @tanstack/react-query, and tiptap related packages, ensuring the project utilizes the latest stable versions.
  • ESLint & Prettier Copying Logic Refinement: Refactored the logic for copying ESLint and Prettier configuration files in create-vitnode. The updated implementation now more robustly handles different project modes (e.g., onlyApi, singleApp, monorepo) and checks for the existence of target directories before copying, improving setup reliability.
  • Next.js Version Handling Simplification: Simplified the Next.js version management within create-vitnode by consolidating nextWebInMonorepo into nextSingle, streamlining how Next.js versions are specified for new projects.
Using Gemini Code Assist

The 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 /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.

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

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request introduces README file generation for new projects and updates a wide range of dependencies across the monorepo. The new README generation logic is a great addition. My review includes a couple of suggestions to improve the robustness and accuracy of the generated documentation. Specifically, I've pointed out a potential issue with a hardcoded instruction in the README template that may not be correct for all project types, and I've suggested a more robust way to handle dynamic content replacement in the README file to avoid future maintenance issues. The dependency updates look good.

@aXenDeveloper aXenDeveloper merged commit 900de8d into canary Nov 15, 2025
4 checks passed
@aXenDeveloper aXenDeveloper deleted the feat/add_replace_readme_for_clit_create_vitnode branch November 15, 2025 08:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

💡 Feature A new feature

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants