Skip to content

docs: auto detect version - #34467

Merged
guanshengliang merged 3 commits into
mainfrom
docs/auto-detect-version
Feb 2, 2026
Merged

docs: auto detect version#34467
guanshengliang merged 3 commits into
mainfrom
docs/auto-detect-version

Conversation

@danielclow

Copy link
Copy Markdown
Contributor

use new placeholder to insert latest version

@gemini-code-assist

Copy link
Copy Markdown
Contributor

Summary of Changes

Hello @danielclow, 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 improves the maintainability and accuracy of the TDengine documentation. By introducing an automated version placeholder, it streamlines the process of updating version numbers across various installation and deployment guides. Additionally, it refines product naming conventions for better consistency, modularizes content for enhanced readability and reusability, and updates Docker image references to reflect current best practices.

Highlights

  • Automated Versioning: Implemented a {{VERSION}} placeholder across documentation files to automatically insert the latest product version, simplifying future updates and ensuring consistency.
  • Product Naming Consistency: Standardized product references from 'TDengine' to 'TDengine TSDB' and updated Docker image names (e.g., tdengine/tdengine to tdengine/tsdb-ee) for clarity and consistency throughout the documentation.
  • Documentation Structure Refinement: Modularized content in 'Get Started' guides by replacing verbose sections with reusable components (e.g., <Getstarted/>) and dynamic card lists for improved readability and navigation.
  • TDgpt Documentation Updates: Applied versioning placeholders and updated Docker run commands to use the latest tag for TDgpt images, along with minor textual corrections for accuracy.

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

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.

@taosdata-bot taosdata-bot Bot added the internal label Feb 2, 2026

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

Copy link
Copy Markdown
Contributor

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 updates the documentation to use a {{VERSION}} placeholder instead of hardcoded version numbers, which is a great improvement for maintainability. The changes also standardize product names like 'TDengine TSDB' and update Docker image references. The refactoring to use shared content with <Getstarted/> is also a good change. I've added a couple of suggestions in docs/en/06-advanced/06-tdgpt/02-tutorial.md to improve clarity for users running specific Docker image versions.

Comment thread docs/en/06-advanced/06-tdgpt/02-tutorial.md
Comment thread docs/en/06-advanced/06-tdgpt/02-tutorial.md
@danielclow
danielclow marked this pull request as ready for review February 2, 2026 10:01
@guanshengliang
guanshengliang merged commit b10d2c1 into main Feb 2, 2026
7 checks passed
@guanshengliang
guanshengliang deleted the docs/auto-detect-version branch February 2, 2026 11:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants