AI Assistant. Updated doc#469
Merged
vvlladd28 merged 3 commits intoJun 12, 2026
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates ThingsBoard documentation around the in-platform AI Assistant, aligning page metadata with the Assistant’s current scope (Alarm Rules + Calculated Fields) and expanding the shared AI Assistant include with usage guidance, screenshots, and AI credits information. It also adds PE-only Tenant Profile “AI Limits” documentation and adjusts Alarm Rules page callouts.
Changes:
- Updated AI Assistant page descriptions across CE/PE/PaaS variants to focus on Alarm Rules and Calculated Fields.
- Expanded the shared AI Assistant include with detailed workflow steps, screenshots, scope/limitations, and AI credits guidance.
- Added a PE-only “AI Limits” section to Tenant Profiles and reorganized Alarm Rules asides to include a permissions note plus a separate best-practice tip.
Reviewed changes
Copilot reviewed 7 out of 12 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| src/content/docs/docs/user-guide/ai-assistant.mdx | Updates page frontmatter description to match current AI Assistant scope. |
| src/content/docs/docs/pe/user-guide/ai-assistant.mdx | Same description alignment for PE docs. |
| src/content/docs/docs/paas/user-guide/ai-assistant.mdx | Same description alignment for PaaS docs. |
| src/content/docs/docs/paas/eu/user-guide/ai-assistant.mdx | Same description alignment for PaaS EU docs. |
| src/content/_includes/docs/user-guide/tenant-profiles.mdx | Adds PE-only “AI Limits” section under profile configuration. |
| src/content/_includes/docs/user-guide/alarm-rules.mdx | Reworks initial callouts: adds a permissions note and keeps the duplication-avoidance tip later. |
| src/content/_includes/docs/user-guide/ai-assistant.mdx | Major content expansion: start steps, screenshots, behavior explanation, AI credits section, and next-step links. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+9
to
+11
| {props.product === Products.PE && ( | ||
| <Banner variant="pe">Available from ThingsBoard PE <strong>4.3.1.2</strong> and later.</Banner> | ||
| )} |
| { | ||
| src: '/src/assets/images/user-guide/ai-assistant/ai-assistant-with-calculated-fields-1.png', | ||
| alt: 'Opening AI Assistant from the Calculated fields page', | ||
| caption: 'Click <strong>Configure with AI</strong> on the Calculated fields page to open th AI Assistant and create or manage calculated fields using natural language.', |
vvlladd28
pushed a commit
that referenced
this pull request
Jun 12, 2026
* Updated AI Assistant doc * Updated Alarm rules doc * Updated AI Assistant guide
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Type of change
src/content/docs/**)src/content/_includes/**)src/components/**,src/styles/**)src/pages/**,src/data/**)src/data/redirects.ts)releaseskill)Affected products
Related issues
Checklist
pnpm checkpasses (Astro / TypeScript)pnpm lint:eslintpassespnpm lint:slugcheckpasses (required if pages were added/renamed/moved across languages)pnpm lint:linkcheckpasses locally — required to merge; run it before requesting review (usepnpm lint:linkcheck:nobuildif you already ran a build)src/data/redirects.ts, andpnpm generate:redirectswas runsrc/data/versions.ts