Skip to content

doc: update user manual. - #34693

Merged
guanshengliang merged 13 commits into
3.0from
doc/refactor
Mar 9, 2026
Merged

guanshengliang merged 13 commits into
3.0from
doc/refactor

Conversation

@hjxilinx

@hjxilinx hjxilinx commented Mar 5, 2026

Copy link
Copy Markdown
Contributor

doc: update user manual.

Checklist

Please check the items in the checklist if applicable.

  • Is the user manual updated?
  • Are the test cases passed and automated?
  • Is there no significant decrease in test coverage?

@gemini-code-assist

Copy link
Copy Markdown
Contributor

Summary of Changes

Hello, 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!

此拉取请求主要旨在更新和优化用户手册,特别是关于 TDgpt 和高级分析功能的文档。通过调整文件路径和更新内容,提高了文档的组织性和准确性,确保用户能够更清晰地理解和使用相关功能,并提供了部署 TDgpt 服务的关键指引。

Highlights

  • 文档目录重构: 重构了 TDgpt 文档的目录结构,将原有的 '09-dev' 路径调整为 '06-dev',并更新了 FAQ 文件的编号,以优化文档的组织和导航。
  • 高级分析文档更新: 更新了高级分析功能的相关文档,包括修正了部分描述性文本,并新增了关于部署 TDgpt 服务的关键指引,以提高文档的准确性和实用性。
  • 文本细节修正: 修正了时序基础模型调用文档中的一处标点符号,以提升文本的规范性。

🧠 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
  • docs/zh/06-advanced/06-TDgpt/06-faq.md
    • 文件被重命名为 docs/zh/06-advanced/06-TDgpt/07-faq.md。
  • docs/zh/06-advanced/06-TDgpt/09-dev/02-algo/02-forecast.md
    • 文件被重命名为 docs/zh/06-advanced/06-TDgpt/06-dev/02-algo/02-forecast.md。
  • docs/zh/06-advanced/06-TDgpt/09-dev/02-algo/03-ad.md
    • 文件被重命名为 docs/zh/06-advanced/06-TDgpt/06-dev/02-algo/03-ad.md。
  • docs/zh/06-advanced/06-TDgpt/09-dev/02-algo/index.md
    • 文件被重命名为 docs/zh/06-advanced/06-TDgpt/06-dev/02-algo/index.md。
  • docs/zh/06-advanced/06-TDgpt/09-dev/03-ml/index.md
    • 文件被重命名为 docs/zh/06-advanced/06-TDgpt/06-dev/03-ml/index.md。
  • docs/zh/06-advanced/06-TDgpt/09-dev/04-tsfm/index.md
    • 文件被重命名为 docs/zh/06-advanced/06-TDgpt/06-dev/04-tsfm/index.md。
  • docs/zh/06-advanced/06-TDgpt/09-dev/index.md
    • 文件被重命名为 docs/zh/06-advanced/06-TDgpt/06-dev/index.md。
  • docs/zh/06-advanced/08-Advanced-Analysis/02-forecast/10-tsfm.md
    • 修正了文本中的一处标点符号。
  • docs/zh/06-advanced/08-Advanced-Analysis/index.md
    • 移除了 'toc_max_heading_level' 配置。
    • 添加了 'description' 元数据。
    • 更新了高级分析功能的描述文本。
    • 新增了关于部署 TDgpt 服务的提示信息。
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 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

这个 PR 主要更新了用户手册,包括一些文件路径的重命名和内容的微调。我发现了一些小问题:

  1. 在一个 Python 代码示例中,错误日志里引用的变量名有误。
  2. 一个 Markdown 文件中的链接因为文件重命名而失效了。
  3. 一处文档描述中存在一个错别字。
    我已经就这些问题提出了具体的修改建议。

Note: Security Review has been skipped due to the limited scope of the PR.

Comment thread docs/zh/06-advanced/06-TDgpt/06-dev/03-ml/index.md Outdated
Comment thread docs/zh/06-advanced/08-Advanced-Analysis/02-forecast/10-tsfm.md Outdated
Comment thread docs/zh/06-advanced/08-Advanced-Analysis/index.md Outdated
hjxilinx and others added 2 commits March 5, 2026 19:11
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Comment thread docs/zh/06-advanced/08-Advanced-Analysis/index.md Outdated
hjxilinx and others added 7 commits March 5, 2026 19:13
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
@guanshengliang
guanshengliang merged commit e1a6c24 into 3.0 Mar 9, 2026
13 checks passed
@guanshengliang
guanshengliang deleted the doc/refactor branch March 9, 2026 09:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants