chore: optimize the rsdoctor skills

[yifancong]

chore: optimize the rsdoctor skills

Split and optimize skill.md and install-rsdoctor.md.

[gemini-code-assist]

Summary of Changes

Hello @yifancong, I'm Gemini Code Assist¹! 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 streamlines and clarifies the documentation for the Rsdoctor analysis skill. The primary goal is to enhance the user experience by providing more precise naming, a more intuitive step-by-step guide for setup and usage, and detailed, conditional instructions for integrating Rsdoctor across different project types and frameworks. These changes collectively aim to make the skill more accessible and understandable for developers performing bundle analysis.

Highlights

• Skill Renaming: The rsdoctor-analytics skill has been consistently renamed to rsdoctor-analysis across the README.md and SKILL.md files for improved clarity and consistency.
• Documentation Structure Enhancement: The SKILL.md file has undergone a significant refactoring, introducing a step-by-step guide for prerequisites, dependency checks, quick start, and workflow, making the documentation more structured and easier to follow.
• Refined Installation and Configuration Guidance: The install-rsdoctor.md reference document now includes detailed scenario decision logic for determining project type and framework, providing conditional installation and configuration instructions for Rspack, Rsbuild, Webpack, and Modern.js projects. This includes updating configuration file extensions (e.g., rspack.config.js to rspack.config.ts) and clarifying plugin setup.
• Simplified CLI Command Examples: Pagination and filtering examples for various CLI commands within SKILL.md have been condensed for brevity and improved readability.
• Concise Bailout Reason Explanation: The explanation for bailoutReason in the side-effects analysis section of SKILL.md has been made more concise while retaining essential information.

🧠 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

• README.md
  • Updated the skill name from rsdoctor-analytics to rsdoctor-analysis in the installation command.
  • Revised the description of the rsdoctor-analysis skill for better clarity.
• skills/rsdoctor-analysis/SKILL.md
  • Renamed the skill from rsdoctor-analytics to rsdoctor-analysis in the front matter and main title.
  • Changed 'legacy packages' to 'packages' in dependency installation instructions.
  • Updated rspack.config.js to rspack.config.ts in configuration file references.
  • Restructured 'Prerequisites' and 'Quick Start' sections into numbered steps for improved flow.
  • Removed detailed plugin configuration examples, directing users to reference/install-rsdoctor.md.
  • Simplified pagination and filtering examples for CLI commands.
  • Condensed the explanation of bailoutReason for side-effects analysis.
  • Updated dependency check instructions to refer to reference/install-rsdoctor.md.
• skills/rsdoctor-analysis/reference/install-rsdoctor.md
  • Added a new 'Scenario Decision Logic' section to guide users on determining projectType and framework.
  • Introduced conditional logic for dependency installation based on projectType ('rspack' or 'webpack').
  • Introduced conditional logic for plugin configuration examples based on framework ('rspack', 'rsbuild', 'webpack', or 'modern.js').
  • Updated the Rsbuild configuration example to explicitly append the RsdoctorRspackPlugin within tools.rspack when the RSDOCTOR environment variable is set.
  • Changed rspack.config.js to rspack.config.ts in the Rspack configuration example.
  • Added conditional logic for output.reportDir configuration examples.

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. ↩

[gemini-code-assist]

Code Review

This pull request significantly improves the documentation for the rsdoctor-analysis skill by refactoring the main SKILL.md file and introducing a new install-rsdoctor.md reference. These changes result in a more structured, clear, and consistent guide for users and AI agents. The instructions are now better organized with clear steps and conditional logic for different project setups. I've added a couple of suggestions to further improve consistency in the command examples. Overall, these are excellent changes that enhance the usability of the skill.

[chenjiahan]

LGTM 👍