-
Notifications
You must be signed in to change notification settings - Fork 5k
docs: update conntector and error code page, remove rest connect type #33266
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Summary of ChangesHello @sheyanjie-qq, 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 focuses on a substantial overhaul of the TDengine documentation, specifically targeting the organization and clarity of information regarding database connectors and error codes. By introducing reusable MDX components and centralizing error code references, the changes aim to provide a more consistent, maintainable, and user-friendly documentation experience. The update also refines the guidance on connection methods, promoting WebSocket connections and clarifying the scope of direct REST API interactions. Highlights
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.
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 significantly improves the documentation by refactoring shared content into reusable components and centralizing the error code information. This enhances maintainability and consistency across the documentation. The changes also seem to de-emphasize REST connections in favor of WebSocket connections, which is a significant strategic update.
My review includes a critical security suggestion for an example file to prevent SQL injection, and a suggestion to improve the clarity and maintainability of the new error code page.
Also, there's a small typo in the pull request title: 'connttector' should be 'connector'.
...mybatisplus-demo/src/main/java/com/taosdata/example/mybatisplusdemo/mapper/MetersMapper.java
Show resolved
Hide resolved
zitsen
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Description
Please briefly describe the code changes in this pull request.
Checklist
Please check the items in the checklist if applicable.