docs: add introduction #7056
docs: add introduction #7056
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @interstellarmt, 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!
I've focused on enhancing the documentation by adding comprehensive guides for two new chart types: Scatter Plots and Word Clouds, available in both English and Chinese. Additionally, I've updated the FAQ section to include a solution for a common JavaScript rendering quirk that causes unexpected commas in custom tooltips. These changes aim to provide clearer and more complete resources for users.
Highlights
- New Scatter Plot Documentation: I've added detailed documentation for Scatter Plots, covering their introduction, components, suitable and unsuitable use cases with examples, various extensions (like trend lines, labels, grouped comparisons, and matrix plots), and a comparison with other chart types. This is available in both English and Chinese.
- New Word Cloud Documentation: I've also introduced comprehensive documentation for Word Clouds, explaining their purpose, components, appropriate and inappropriate scenarios, and how they compare to bubble and bar charts. This documentation is provided in both English and Chinese.
- Removed Placeholder Documentation: The placeholder documentation files for Scatter Plots and Word Clouds have been removed as they are now replaced by the new, complete documentation.
- New FAQ Entry on Tooltip Rendering: I've added a new entry to the FAQ section that addresses a common issue: why commas might appear in custom rendered tooltips. It explains the root cause (JavaScript's
Array.prototype.toString()behavior) and provides solutions using.join('')and other methods.
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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| 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 issue 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 or fill out our survey to provide feedback.
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
-
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. ↩
There was a problem hiding this comment.
Code Review
This pull request introduces well-written and comprehensive documentation for Scatter Plots and Word Clouds, complete with use cases, examples, and comparisons. Additionally, it adds a valuable FAQ entry that clarifies a common issue with custom tooltips. The new content is a great addition. I've included a few minor suggestions to enhance consistency and clarity in the new documentation files.
Pull Request Test Coverage Report for Build 16617689049Details
💛 - Coveralls |
Checklist
Description of change