Skip to content

feat/easyuse: add easyuse md and relative images - #523

Merged
feici02 merged 8 commits into
taosdata:mainfrom
dormousewz:feat/easyuse
Aug 14, 2026
Merged

feici02 merged 8 commits into
taosdata:mainfrom
dormousewz:feat/easyuse

Conversation

@dormousewz

Copy link
Copy Markdown

Description

Issue(s)

  • Close/close/Fix/fix/Resolve/resolve: Issue Link

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?

Copilot AI lite review requested due to automatic review settings August 14, 2026 12:28

Copilot AI 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.

Pull request overview

This PR adds a new Administration documentation page describing TDengine EasyUse, including its value proposition, environment prerequisites, deployment steps, MCP configuration, and an end-to-end demo walkthrough, with chapter-local images referenced via relative paths.

Changes:

  • Add a new Chinese doc page 14-easyuse.md under docs/14-administration/ describing EasyUse usage and setup flow.
  • Include multiple CLI/config examples and embed related screenshots via ./images/... references.
  • Document an end-to-end “污水处理厂” demo output (models, asset tree, dashboards, alerts).
Suppressed comments (8)

docs/14-administration/14-easyuse.md:2

  • This doc page is missing the front matter (--- block with title and sidebar_label) that other docs in this chapter use, which will affect sidebar labeling and consistency.
# 14\.14 TDengine EasyUse:通过自然语言一键式搭建 TDengine Demo

docs/14-administration/14-easyuse.md:117

  • Filename appears to be a typo (logint_info.txt). This should be consistent with the earlier section summary row and the actual file name users are expected to edit.
默认在 idmp\-easyuse 目录下打开 logint\_info\.txt,并根据真实用户信息修改:

docs/14-administration/14-easyuse.md:134

  • Product name casing and Chinese typography are inconsistent here (EasyUse vs Easyuse, English commas, missing space before “等”). This hurts readability and search consistency.
TDengine Easyuse 可通过各种支持 Skill 的智能体运行,例如:Claude Code, Codex, OpenCode, WorkBuddy等。智能体负责解析自然语言、调度技能完成任务。

docs/14-administration/14-easyuse.md:142

  • This block contains shell commands; mark it as bash instead of Plain Text so it renders consistently and passes the repo’s “code blocks must specify language” convention.
```Plain Text

docs/14-administration/14-easyuse.md:232

  • This block is JSON; mark it as json instead of Plain Text for correct highlighting/linting.
```Plain Text

docs/14-administration/14-easyuse.md:273

  • This example command also includes a trailing Chinese period (。), which users may copy/paste. Remove it to keep the command valid.
/idmp-easyuse 创建污水处理demo。

docs/14-administration/14-easyuse.md:354

  • Product name casing is inconsistent here (“Easyuse” vs “EasyUse”), and Chinese typography should include a space in “30 分钟”.
TDengine Easyuse 将构建工业数据平台的过程,从“数天准备、多人协同、反复修改”,到 “30分钟量级、一句话启动、直接进入优化”,它所带来的变化已经不只是效率提升,而是项目启动逻辑本身的重构,它让行业专家的经验第一次能够更快地变成系统、变成结果、变成可验证的起点。

docs/14-administration/14-easyuse.md:253

  • The auth description row is currently garbled (placeholder masking removed key parts), so readers won’t know the required header format. Please restore a clear, non-secret placeholder.
|**URL**|http://\<idmp\-host\>:6042/api/v1/mcp/stream|
|**鉴权**|Authorization: Bearer \<14\.14\.4 中创建的 API Key\>|


💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread docs/14-administration/14-easyuse.md Outdated
@@ -0,0 +1,355 @@
# 14\.14 TDengine EasyUse:通过自然语言一键式搭建 TDengine Demo
Comment thread docs/14-administration/14-easyuse.md Outdated

整套流程走下来,有经验的团队也需要花费数天甚至数周的时间。

TDengine EasyUse 将上述工作压缩为**一句自然语言**:客户或售前工程师只需描述业务场景(例如"污水处理厂智能监控"),技能会自动完成建模、资产树、可视化面板、** **实时分析的全部创建工作,将 Demo 的交付时间从"数天"缩短到"几十分钟",对内部汇报、方案评审、项目立项,它完全够用。
|---|---|
|**操作系统**|Linux(推荐)、macOS,或 Windows \+ WSL|
|**权限**|Linux 需 root;Windows 需管理员权限(用于 All\-in\-One 部署)|
|**CPU**|x64,arm 且支持 AVX2(TDgpt 依赖)|
Comment thread docs/14-administration/14-easyuse.md Outdated

5. **立即复制并妥善保存**——列表页后续仅显示掩码。

> **备注** API Key 继承创建者的角色权限与元素访问范围。若后续被删除或所属用户被停用,API Key 立即失效。请求头格式固定为 Authorization: Bearer \<api\_\.\.\.\>,其中 **不需要**手动加 Bearer 前缀到 Key 本身。
Comment thread docs/14-administration/14-easyuse.md Outdated
Comment on lines +12 to +14
|**14\.14\.4 创建 API Key**|为 MCP 调用准备鉴权凭据|
|**14\.14\.5 编写 login\.txt**|提供 EasyUse 运行所需的登录信息|
|**14\.14\.6 安装智能体**|安装智能体并选择适当的模型|
Comment thread docs/14-administration/14-easyuse.md Outdated

## 14\.14\.7 部署 EasyUse 技能包

EasyUse 由三个协同工作的技能组成,需要从内部 GitLab 拉取后放入 OpenCode 的技能目录 \.opencode/。

3. 部署完成后,在浏览器中打开:

```Plain Text
在 OpenCode 会话中,用自然语言调用 EasyUse 技能。命令基础格式为:

```Plain Text
/idmp-easyuse <业务场景描述>。
Copilot AI review requested due to automatic review settings August 14, 2026 12:42

Copilot AI 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.

Pull request overview

Copilot reviewed 1 out of 6 changed files in this pull request and generated no new comments.

Suppressed comments (13)

docs/14-administration/14-easyuse.md:1

  • Per docs-guide.md:14, Chinese docs under docs/ must be mirrored by an English file under i18n/en/docusaurus-plugin-content-docs/current/ with the exact same path/filename. This PR adds docs/14-administration/14-easyuse.md but does not add i18n/en/docusaurus-plugin-content-docs/current/14-administration/14-easyuse.md.
# 14\.14 TDengine EasyUse:通过自然语言一键式搭建 TDengine Demo

docs/14-administration/14-easyuse.md:58

  • The CPU requirement line is inconsistent with the All-in-One deployment requirements and is technically confusing: AVX2 is an x64 feature, so "arm 且支持 AVX2" reads as incorrect. docs/14-administration/40-all-in-one-deploy/index.md:34 states the requirement as "x64 CPU 必须支持 AVX2".
|**CPU**|x64,arm 且支持 AVX2(TDgpt 依赖)|

docs/14-administration/14-easyuse.md:222

  • The MCP config snippet is fenced as Plain Text, but it's JSON. Using json improves readability and consistency with the docs guide's language-tagged fences.
```Plain Text

docs/14-administration/14-easyuse.md:138

  • Shell commands are fenced as Plain Text. For consistent rendering and syntax highlighting, use a concrete language like bash for command snippets (see docs-guide.md:186-196).
```Plain Text
curl -fsSL https://opencode.ai/install | bash
source ~/.bashrc         # 或 ~/.zshrc,取决于所用 Shell

docs/14-administration/14-easyuse.md:261

  • The example command includes a trailing Chinese period "。" inside the code block, which can break copy/paste. Consider adding a space before "demo" for readability in Chinese contexts.
```Plain Text
/idmp-easyuse 创建污水处理demo。

docs/14-administration/14-easyuse.md:1

  • This page is missing the YAML front matter (--- with title/sidebar_label) that other pages in this chapter use (e.g., docs/14-administration/01-deployment-architecture.md:1-4). Without it, the sidebar label/title metadata may be inconsistent in Docusaurus.
# 14\.14 TDengine EasyUse:通过自然语言一键式搭建 TDengine Demo

docs/14-administration/14-easyuse.md:177

  • This sentence says the skills need to be pulled from an "内部 GitLab", but the very next command clones from GitHub. This is internally inconsistent and will confuse readers about where to obtain the skills.
EasyUse 由三个协同工作的技能组成,需要从内部 GitLab 拉取后放入 OpenCode 的技能目录 \.opencode/。

docs/14-administration/14-easyuse.md:13

  • The TOC entry for 14.14.5 says "编写 login.txt", but the actual section title is "修改登录信息文件". Keeping TOC labels aligned with headings avoids navigation confusion.
|**14\.14\.5 编写 login\.txt**|提供 EasyUse 运行所需的登录信息|

docs/14-administration/14-easyuse.md:128

  • Product name capitalization and Chinese/English spacing are inconsistent here ("Easyuse", "WorkBuddy等"). Use consistent branding ("EasyUse") and add spacing between English and Chinese for readability.
TDengine Easyuse 可通过各种支持 Skill 的智能体运行,例如:Claude Code, Codex, OpenCode, WorkBuddy等。智能体负责解析自然语言、调度技能完成任务。

docs/14-administration/14-easyuse.md:69

  • These numbered sub-sections are formatted as bold text rather than headings, so they won't appear in the page TOC and are inconsistent with other pages in this chapter (e.g., 09-sample-data.md uses ### 14.9.1.1 ...). Converting to a real heading improves navigation.
**14\.14\.3\.1 部署步骤**

docs/14-administration/14-easyuse.md:342

  • Product name capitalization and spacing are inconsistent here ("Easyuse", "30分钟"). Use consistent branding ("EasyUse") and add a space in "30 分钟" to match the typography used elsewhere in the docs.
TDengine Easyuse 将构建工业数据平台的过程,从“数天准备、多人协同、反复修改”,到 “30分钟量级、一句话启动、直接进入优化”,它所带来的变化已经不只是效率提升,而是项目启动逻辑本身的重构,它让行业专家的经验第一次能够更快地变成系统、变成结果、变成可验证的起点。

docs/14-administration/14-easyuse.md:78

  • This fenced code block uses Plain Text as the language tag. The docs guide requires a language specifier (docs-guide.md:186-196), and Plain Text (with a space) is typically not a recognized Prism language in Docusaurus. Prefer text for plain output/URLs.

This issue also appears in the following locations of the same file:

  • line 136
  • line 222
```Plain Text
http://localhost:6042

docs/14-administration/14-easyuse.md:253

  • The command template includes a trailing Chinese period "。" inside the code block. If readers copy/paste, the extra punctuation will likely break the command. Also prefer a text fence tag instead of Plain Text.

This issue also appears on line 260 of the same file.

```Plain Text
/idmp-easyuse <业务场景描述>。

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. Change filename to 50-easyuse.md
  2. Add frontmatter

Copilot AI review requested due to automatic review settings August 14, 2026 13:05
Comment thread docs/14-administration/50-easyuse.md Outdated
title: 通过自然语言一键式搭建 TDengine Demo
sidebar_label: 通过自然语言一键式搭建 TDengine Demo
---
# 14\.14 通过自然语言一键式搭建 TDengine Demo

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Backslash is not necessary here.

Copilot AI 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.

Pull request overview

Copilot reviewed 1 out of 6 changed files in this pull request and generated no new comments.

Suppressed comments (14)

docs/14-administration/50-easyuse.md:265

  • 示例命令末尾包含中文句号“。”且 demo 大小写/空格不统一;建议移除句号并统一 Demo 写法,避免用户复制粘贴出错。
/idmp-easyuse 创建污水处理demo。

docs/14-administration/50-easyuse.md:62

  • CPU 要求表述不准确:AVX2 是 x86/x64 指令集扩展,无法用于泛指 ARM。建议改为仅要求 x64 且支持 AVX2(与 All-in-One 部署文档一致),或单独说明 ARM 的支持情况。
|**CPU**|x64,arm 且支持 AVX2(TDgpt 依赖)|

docs/14-administration/50-easyuse.md:140

  • Shell 命令示例建议使用 ```bash 代码块(而不是 Plain Text),以便正确高亮且与仓库既有文档一致。
```Plain Text

docs/14-administration/50-easyuse.md:226

  • JSON 配置示例建议使用 ```json 代码块(当前为 Plain Text),以便语法高亮并与仓库既有文档一致。
```Plain Text

docs/14-administration/50-easyuse.md:4

  • 该页面新增在 docs/ 下,但未找到对应的英文镜像文件 i18n/en/docusaurus-plugin-content-docs/current/14-administration/50-easyuse.md;本仓库要求中英文目录结构与文件名保持一致,否则英文站点会缺页。
---
title: 通过自然语言一键式搭建 TDengine Demo
sidebar_label: 通过自然语言一键式搭建 TDengine Demo
---

docs/14-administration/50-easyuse.md:9

  • 新增了系统管理章节的新页面,但 docs/14-administration/index.md(以及对应英文 index)当前未在章节概览表中覆盖 EasyUse 相关内容;按本仓库新增页面流程应在章节 index 中补充入口,方便读者发现。
# 14\.14 通过自然语言一键式搭建 TDengine Demo

TDengine EasyUse 是一个面向 TDengine 的"一键式"自动化编排技能。用户只需用自然语言描述业务场景(例如:污水处理厂智能监控),即可自动完成**数据建模 → 资产目录构建 → 实时分析规则设置 → 可视化面板配置**的完整链路。

本章介绍该技能的核心价值、环境准备、部署步骤与实战案例。完成本章操作后,读者可在本机独立复现一个完整的行业 Demo。

docs/14-administration/50-easyuse.md:73

  • 本节使用加粗文本作为“14.14.x.1”子小节标题,不会进入文档目录结构,且与本仓库同类文档的分级标题写法不一致。建议改为 Markdown 标题(例如 ### 14.14.3.1 ...),并在全文保持一致。

This issue also appears in the following locations of the same file:

  • line 140
  • line 226
**14\.14\.3\.1 部署步骤**

docs/14-administration/50-easyuse.md:115

  • 登录信息文件名写为 logint_info.txt,疑似拼写错误(logint)。同时目录处写的是 login.txt,前后不一致会导致读者找不到文件。建议统一文件名(例如 login_info.txt)并与技能仓库实际文件保持一致。
默认在 idmp\-easyuse 目录下打开 logint\_info\.txt,并根据真实用户信息修改:

docs/14-administration/50-easyuse.md:257

  • 命令示例末尾包含中文句号“。”,用户复制粘贴会导致命令不匹配。建议在代码块中仅保留实际可执行的命令文本。

This issue also appears on line 265 of the same file.

/idmp-easyuse <业务场景描述>。

docs/14-administration/50-easyuse.md:132

  • 产品/能力名称大小写不一致(Easyuse vs EasyUse),且中英文混排处缺少空格(WorkBuddy等)。建议统一为 EasyUse,并按中文排版在英文单词与“等”之间留空格、列表用中文顿号分隔。
TDengine Easyuse 可通过各种支持 Skill 的智能体运行,例如:Claude Code, Codex, OpenCode, WorkBuddy等。智能体负责解析自然语言、调度技能完成任务。

docs/14-administration/50-easyuse.md:346

  • 结尾段落存在 Easyuse 大小写不一致、以及“30分钟”中英文混排缺少空格(建议写作“30 分钟”)的问题;这类排版通常会被 AutoCorrect/typos 检查出。
TDengine Easyuse 将构建工业数据平台的过程,从“数天准备、多人协同、反复修改”,到 “30分钟量级、一句话启动、直接进入优化”,它所带来的变化已经不只是效率提升,而是项目启动逻辑本身的重构,它让行业专家的经验第一次能够更快地变成系统、变成结果、变成可验证的起点。

docs/14-administration/50-easyuse.md:81

  • 代码块语言标记使用了 Plain Text(本仓库其他文档通常使用 text/bash/json 等小写标记);不一致可能导致 markdownlint 或高亮渲染问题。建议将纯文本块改为 ```text(并在全文统一调整)。
```Plain Text

docs/14-administration/50-easyuse.md:181

  • 这里写“从内部 GitLab 拉取”,但后续命令实际是从 GitHub 克隆;描述与示例不一致会误导读者。建议统一为实际来源(或替换为正确的 GitLab 地址)。
EasyUse 由三个协同工作的技能组成,需要从内部 GitLab 拉取后放入 OpenCode 的技能目录 \.opencode/。

docs/14-administration/50-easyuse.md:17

  • 章节目录中“14.14.5 编写 login.txt”与下文小节标题“修改登录信息文件”不一致,且后文文件名也不同;建议在目录处与实际小节标题保持一致,避免读者按目录操作时产生歧义。
|**14\.14\.5 编写 login\.txt**|提供 EasyUse 运行所需的登录信息|

Copilot AI review requested due to automatic review settings August 14, 2026 13:14
Comment thread docs/14-administration/14-easyuse.md Outdated

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please remove the old file.

Copilot AI 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.

Pull request overview

Copilot reviewed 1 out of 6 changed files in this pull request and generated no new comments.

Suppressed comments (7)

docs/14-administration/50-easyuse.md:62

  • The CPU requirement mixes architectures incorrectly: AVX2 is an x86 (x64) instruction set and does not apply to ARM. As written, this requirement is self-contradictory for ARM; please clarify the supported CPU architectures and AVX2 requirement.
|**CPU**|x64,arm 且支持 AVX2(TDgpt 依赖)|

docs/14-administration/50-easyuse.md:5

  • docs/14-administration/ now contains both 14-easyuse.md and 50-easyuse.md with the same page title/subject. Keeping two near-duplicate pages will create confusing sidebar entries and potentially duplicate routes/content; please consolidate to a single canonical doc (and update any links/index accordingly).
---
title: 通过自然语言一键式搭建 TDengine Demo
sidebar_label: 通过自然语言一键式搭建 TDengine Demo
---
# 14.14 通过自然语言一键式搭建 TDengine Demo

docs/14-administration/50-easyuse.md:132

  • Product name casing and Chinese typography are inconsistent here: Easyuse should be EasyUse, and the English product list should use Chinese list punctuation and a space before “等”.
TDengine Easyuse 可通过各种支持 Skill 的智能体运行,例如:Claude Code, Codex, OpenCode, WorkBuddy等。智能体负责解析自然语言、调度技能完成任务。

docs/14-administration/50-easyuse.md:181

  • This sentence says the skills need to be pulled from “内部 GitLab”, but the command shown clones from GitHub (https://github.com/taosdata/agent-skills.git). Please make the source consistent (either update the text or the URL) to avoid confusing readers.
EasyUse 由三个协同工作的技能组成,需要从内部 GitLab 拉取后放入 OpenCode 的技能目录 .opencode/。

docs/14-administration/50-easyuse.md:226

  • The fenced code block language tag Plain Text (with a space) is inconsistent with the rest of the docs, which use standard fenced languages like bash, json, text. This block is JSON, so using json improves highlighting and avoids tooling/lint quirks.
```Plain Text

docs/14-administration/50-easyuse.md:115

  • The login info filename is inconsistent within this doc: the section list says login.txt, but here it references logint_info.txt (likely a typo) and later steps depend on the exact filename. Please standardize to the actual file name used by EasyUse and keep the section list in sync.
默认在 idmp-easyuse 目录下打开 logint_info.txt,并根据真实用户信息修改:

docs/14-administration/50-easyuse.md:4

  • Whichever EasyUse page you keep as the canonical Chinese doc, it needs a corresponding English file under i18n/en/docusaurus-plugin-content-docs/current/ with the same path/filename (repo rule in docs-guide.md lines 9–15). Please add the English mirror (and mirror chapter-local images if referenced) so the two locales stay in sync.
---
title: 通过自然语言一键式搭建 TDengine Demo
sidebar_label: 通过自然语言一键式搭建 TDengine Demo
---

Copilot AI review requested due to automatic review settings August 14, 2026 13:22

Copilot AI 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.

Pull request overview

Copilot reviewed 1 out of 6 changed files in this pull request and generated no new comments.

Suppressed comments (18)

docs/14-administration/50-easyuse.md:117

  • 代码块语言标记使用了 Plain Text,建议改为 text 以符合仓库中其它文档的写法并避免解析成未知语言。
```Plain Text

docs/14-administration/50-easyuse.md:153

  • 代码块语言标记使用了 Plain Text,建议改为 text 以符合仓库中其它文档的写法并避免解析成未知语言。
```Plain Text

docs/14-administration/50-easyuse.md:62

  • 这里的 CPU 要求写成了“x64,arm 且支持 AVX2”,但 AVX2 是 x64 指令集扩展;仓库内其它部署文档也描述为“x64 CPU 必须支持 AVX2”。建议删除/更正 arm + AVX2 的表述,避免误导。
|**CPU**|x64,arm 且支持 AVX2(TDgpt 依赖)|

docs/14-administration/50-easyuse.md:265

  • 命令示例末尾包含中文句号(。),读者复制粘贴时会导致命令不可用。建议在代码块内去掉结尾标点。
/idmp-easyuse 创建污水处理demo。

docs/14-administration/50-easyuse.md:4

  • 按仓库文档约定,新增/编辑中文文档时需要在 i18n/en/docusaurus-plugin-content-docs/current/ 下创建同路径的英文版本,否则中英文目录结构会不一致、英文站点也缺页。
---
title: 通过自然语言一键式搭建 TDengine Demo
sidebar_label: 通过自然语言一键式搭建 TDengine Demo
---

docs/14-administration/50-easyuse.md:73

  • 这里用加粗文本表示小节标题(14.14.3.1),与仓库里普遍使用的 Markdown 标题层级(### 14.xx.x.x)不一致,影响目录锚点/可读性。建议将这些“14.14.x.x ...”行改为对应级别的标题(### 或 ####)。
**14.14.3.1 部署步骤**

docs/14-administration/50-easyuse.md:81

  • 代码块语言标记使用了 Plain Text,在 CommonMark/Docusaurus 中会被解析为语言 Plain + metastring,导致代码高亮/校验不符合仓库惯例。建议改为 text。

This issue also appears in the following locations of the same file:

  • line 117
  • line 153
```Plain Text

docs/14-administration/50-easyuse.md:17

  • 章节总览表中“14.14.5”写的是“编写 login.txt”,但正文对应小节标题为“修改登录信息文件”,且后文提到的文件名也不同,容易让读者找不到对应步骤。建议这里与正文小节标题保持一致。
|**14.14.5 编写 login.txt**|提供 EasyUse 运行所需的登录信息|

docs/14-administration/50-easyuse.md:107

  • 这里的请求头示例未用行内代码包裹,且包含尖括号占位符,容易被 Markdown 当作 HTML 片段处理而显示异常。建议将请求头格式用反引号包裹,确保读者可直接复制。
> **备注** API Key 继承创建者的角色权限与元素访问范围。若后续被删除或所属用户被停用,API Key 立即失效。请求头格式固定为 Authorization: Bearer <api_...>,其中 **不需要**手动加 Bearer 前缀到 Key 本身。

docs/14-administration/50-easyuse.md:115

  • 文件名 logint_info.txt 似乎是拼写错误(多了一个 t),会导致读者按文档创建/查找文件时出错。建议更正为一致且常见的 login_info.txt(并在全文保持一致)。
默认在 idmp-easyuse 目录下打开 logint_info.txt,并根据真实用户信息修改:

docs/14-administration/50-easyuse.md:132

  • 产品/功能名大小写不一致(Easyuse vs EasyUse),且英文单词与中文“等”之间缺少空格,容易触发排版/拼写检查。建议统一写作 EasyUse,并补齐空格。
TDengine Easyuse 可通过各种支持 Skill 的智能体运行,例如:Claude Code, Codex, OpenCode, WorkBuddy等。智能体负责解析自然语言、调度技能完成任务。

docs/14-administration/50-easyuse.md:140

  • 该代码块是 shell 命令示例,建议使用 bash 作为代码块语言(而不是 Plain Text),便于高亮与一致性。
```Plain Text

docs/14-administration/50-easyuse.md:157

  • 这里的截图 alt 文本中英文/中文之间缺少空格,按仓库中文排版规则建议补齐,以便阅读与一致性。
![OpenCode初始界面](./images/easyuse-open-opencode.png)

docs/14-administration/50-easyuse.md:181

  • 此处写“从内部 GitLab 拉取”,但下方示例命令实际是从 GitHub 仓库 clone,前后不一致会让读者困惑。建议与命令保持一致,并将目录名用行内代码标注。
EasyUse 由三个协同工作的技能组成,需要从内部 GitLab 拉取后放入 OpenCode 的技能目录 .opencode/。

docs/14-administration/50-easyuse.md:245

  • 该 URL 示例包含 <idmp-host> 占位符,未用行内代码包裹时可能被 Markdown 当作 HTML 片段处理而显示异常。建议将整段 URL 用反引号包裹。
|**URL**|http://<idmp-host>:6042/api/v1/mcp/stream|

docs/14-administration/50-easyuse.md:246

  • 鉴权头示例同样建议用行内代码包裹,避免尖括号占位符被 Markdown 当作 HTML 处理,也方便读者复制。
|**鉴权**|Authorization: Bearer <14.14.4 中创建的 API Key>|

docs/14-administration/50-easyuse.md:257

  • 命令示例末尾包含中文句号(。),读者复制粘贴时会导致命令不可用。建议在代码块内去掉结尾标点。

This issue also appears on line 265 of the same file.

/idmp-easyuse <业务场景描述>。

docs/14-administration/50-easyuse.md:346

  • 这里同样存在 EasyUse 大小写不一致(Easyuse)以及“30分钟”缺少数字与单位间空格的问题,可能触发排版/拼写检查。建议统一为 EasyUse,并写作“30 分钟”。
TDengine Easyuse 将构建工业数据平台的过程,从“数天准备、多人协同、反复修改”,到 “30分钟量级、一句话启动、直接进入优化”,它所带来的变化已经不只是效率提升,而是项目启动逻辑本身的重构,它让行业专家的经验第一次能够更快地变成系统、变成结果、变成可验证的起点。

Copilot AI review requested due to automatic review settings August 14, 2026 14:17

Copilot AI 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.

Pull request overview

Copilot reviewed 1 out of 6 changed files in this pull request and generated no new comments.

Suppressed comments (7)

docs/14-administration/50-easyuse.md:62

  • CPU 要求写成“x64,arm 且支持 AVX2”不准确:AVX2 是 x64 指令集扩展,通常不适用于 ARM;且本仓库 All-in-One 部署文档中明确要求“x64 CPU 必须支持 AVX2”。建议这里与前文要求保持一致并去掉 ARM+AVX2 的表述。
|**CPU**|x64,arm 且支持 AVX2(TDgpt 依赖)|

docs/14-administration/50-easyuse.md:115

  • 登录信息文件名写成了 logint_info.txt(多了一个 t),与 EasyUse 技能文档中常见的 login_info.txt 不一致,容易导致用户找不到/创建错文件。
默认在 idmp-easyuse 目录下打开 logint_info.txt,并根据真实用户信息修改:

docs/14-administration/50-easyuse.md:346

  • 此处“TDengine Easyuse”大小写与全文其它位置不一致,且“30分钟”按中文排版/AutoCorrect 规则通常需要数字与单位之间留空格(如“30 分钟”)。建议统一修正,避免自动检查失败或排版不一致。
TDengine Easyuse 将构建工业数据平台的过程,从“数天准备、多人协同、反复修改”,到 “30分钟量级、一句话启动、直接进入优化”,它所带来的变化已经不只是效率提升,而是项目启动逻辑本身的重构,它让行业专家的经验第一次能够更快地变成系统、变成结果、变成可验证的起点。

docs/14-administration/50-easyuse.md:4

  • 根据仓库文档结构约定(docs/ 与 i18n/en 必须镜像相同路径),新增了中文页面 docs/14-administration/50-easyuse.md 但缺少对应的英文页面 i18n/en/docusaurus-plugin-content-docs/current/14-administration/50-easyuse.md;这会导致中英文内容不一致。
---
title: 通过自然语言一键式搭建 TDengine Demo
sidebar_label: 通过自然语言一键式搭建 TDengine Demo
---

docs/14-administration/50-easyuse.md:17

  • 目录表中 14.14.5 写为“编写 login.txt”,但正文实际是“修改登录信息文件”,且后文文件名也不是 login.txt。建议在目录表中统一为“修改登录信息文件(login_info.txt)”,避免读者按错误文件名操作。

This issue also appears on line 115 of the same file.

|**14.14.3 部署 TDengine**|通过 All-in-One 一键部署基础环境|
|**14.14.4 创建 API Key**|为 MCP 调用准备鉴权凭据|
|**14.14.5 编写 login.txt**|提供 EasyUse 运行所需的登录信息|
|**14.14.6 安装智能体**|安装智能体并选择适当的模型|

docs/14-administration/50-easyuse.md:181

  • 这里写“从内部 GitLab 拉取”,但下面给出的示例命令是从 GitHub (github.com/taosdata/agent-skills) clone,会造成来源描述与实际操作不一致。建议统一为 GitHub(或替换为真实的 GitLab 地址)。
EasyUse 由三个协同工作的技能组成,需要从内部 GitLab 拉取后放入 OpenCode 的技能目录 .opencode/。

docs/14-administration/50-easyuse.md:132

  • 产品/功能名大小写应保持一致:此处写成了“TDengine Easyuse”,但全文其它位置使用“EasyUse”。另外“WorkBuddy等”建议在中文排版中为英文与“等”之间留空格。

This issue also appears on line 346 of the same file.

TDengine Easyuse 可通过各种支持 Skill 的智能体运行,例如:Claude Code, Codex, OpenCode, WorkBuddy等。智能体负责解析自然语言、调度技能完成任务。

Comment thread docs/14-administration/50-easyuse.md Outdated
Copilot AI review requested due to automatic review settings August 14, 2026 15:03

Copilot AI 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.

Copilot was unable to review this pull request because the user who requested the review is ineligible. To be eligible to request a review, you need a paid Copilot license, or your organization must enable Copilot code review.

@feici02 feici02 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@feici02
feici02 merged commit 28b2864 into taosdata:main Aug 14, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants