Repository navigation
Added more formats to the MkDocs page - #501
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 @liuzicheng1987, 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 updates the project's MkDocs configuration to accurately list all supported serialization and deserialization formats. The change ensures that the public-facing site description provides a complete and current overview of the C++20 library's capabilities, enhancing clarity for users and potential adopters.
Highlights
- Documentation Update: The
mkdocs.yamlconfiguration file has been updated to reflect a more comprehensive list of supported serialization formats. - New Supported Formats: The
site_descriptionnow explicitly includes AVRO, Cap'n Proto, CSV, parquet, and UBJSON among the supported formats.
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. 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
-
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 updates the site description in mkdocs.yaml to include a more comprehensive list of supported data formats. This is a great improvement to keep the documentation aligned with the library's features. I've added one suggestion to improve the formatting of the list for better consistency and readability.
| site_description: >- | ||
| A C++20 library for fast serialization, deserialization and validation using reflection. | ||
| Supports JSON, BSON, CBOR, flexbuffers, msgpack, TOML, XML, YAML / msgpack.org[C++20] | ||
| Supports JSON, AVRO, BSON, Cap'n Proto, CBOR, CSV, flexbuffers, msgpack, parquet, TOML, UBJSON, XML, YAML |
There was a problem hiding this comment.
For better readability and consistency, it would be great to sort the list of supported formats alphabetically and use consistent casing as seen in the navigation menu. For example, AVRO could be Avro, flexbuffers could be FlexBuffers, and so on.
Supports Avro, BSON, Cap'n Proto, CBOR, CSV, FlexBuffers, JSON, MessagePack, Parquet, TOML, UBJSON, XML, YAML 
No description provided.