Repository navigation
Note Slack channel membership for alerts and deliveries, document Incomplete periods, and add a top-N recipe - #1639
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
lightdash-bot
added
the
cloudy-needs-review
Documentation validation✅ All blocking checks passed. Component system0 finding(s) across the corpus. Findings on lines this pull request touched are annotated inline in Files changed. |
lightdash-bot
changed the title
lightdash-bot
changed the title
lightdash-bot
changed the title
| - **Fewer than two agents?** You can still write and save instructions, but the router won't run in that project until at least two accessible agents exist. Lightdash shows a note when this is the case. | ||
| - **Instructions can't reference the dashboard or chart a question is asked from.** The router only receives the typed question, your routing instructions, and each agent's description, instructions, data access, and verified questions — it never sees which dashboard or chart the question is pinned to. A rule like *"route questions asked from the Acme dashboard to the Acme agent"* has nothing to match, and the question falls through to the picker. Write rules against words that appear in the question itself. | ||
|
|
||
| ## Keep teams or brands on separate agents without routing instructions |
There was a problem hiding this comment.
remove this whole change - don't touch this page
|
|
||
| New charts have this on by default, whether you create them in the UI, through the API, from chart-as-code, or with an agent. A chart you already saved keeps its stored setting instead of picking up that default, so tick **Indicate incomplete periods** to turn it on for an existing chart. | ||
|
|
||
| In chart-as-code, this is `layout.showIncompletePeriod` (boolean). |
There was a problem hiding this comment.
remove the charts as code reference - add it to the "as code" doc instead if it's not there already
| - **Rules are advisory.** They guide the router's choice but **never override an agent's access restrictions**. A rule can only point to agents the user can already access. | ||
| - **Tagged agents must belong to the project.** You can only tag agents that exist in the selected project. | ||
| - **Fewer than two agents?** You can still write and save instructions, but the router won't run in that project until at least two accessible agents exist. Lightdash shows a note when this is the case. | ||
| - **Instructions can't reference the dashboard or chart a question is asked from.** The router only receives the typed question, your routing instructions, and each agent's description, instructions, data access, and verified questions — it never sees which dashboard or chart the question is pinned to. A rule like *"route questions asked from the Acme dashboard to the Acme agent"* has nothing to match, and the question falls through to the picker. Write rules against words that appear in the question itself. |
|
Pushed Review pass: drop AI router grouping section and move chart-as-code reference for the review comments above.
Removed:
Review closely, this is a larger change than usual: agents/enable-ai-router.mdx: removes or rewords 14 of the 79 lines the page has on main, starting with "- Fewer than two agents? You can still write and save…", "- **Instructions can't reference the dashboard or chart a…", "## Keep teams or brands on separate agents without routin…" and 11 more; agents/enable-ai-router.mdx: drops or retitles the headings "## Keep teams or brands on separate agents without routin…", "## Router and Slack" Comment again to change more, or merge when it is right. |
|
Pushed Review pass: restore the Fewer than two agents bullet and Router and Slack heading for the review comments above.
Comment again to change more, or merge when it is right. |
|
The comment on the chart configuration page's "Incomplete periods" section ("this is correct") is an approval, not a change request — the current branch state already matches what the reviewer is confirming: the section is in place, and the chart-as-code field reference now lives on the content-as-code page per their earlier request. No edit needed, so no commit opened for this pass. |
jpetey75
changed the title
Docs changes Cloudy's docs writer made from support threads on Friday 30 October 2026. One commit per change, described below in order; review by commit and comment on any to drop or change. Every commit builds on current main, so merge whenever it is green, including midday for an urgent fix: later changes that day start a new PR.
Note Slack app channel membership for alerts and delivery recipients
Pages
What changes
Why
Readers creating a Slack alert or adding a Slack recipient to a scheduled delivery had no pointer to the requirement that the Lightdash app already be a channel member, so they only learned it after hitting the missing channels:join scope error.
Checked against
packages/backend/src/clients/Slack/SlackClient.tspackages/common/src/types/slackSettings.tsCloudy found this docs gap while working a support thread. Started from this internal Slack thread (Lightdash workspace only).
Document the Incomplete periods checkbox in the Series tab
Pages
What changes
layout.showIncompletePeriodchart-as-code keyWhy
The Series tab's Incomplete periods checkbox (dashed lines on line/area, hatched bars on bar charts) had no documentation anywhere on the site.
Checked against
packages/frontend/src/components/VisualizationConfigs/ChartConfigPanel/Series/IncompletePeriodSection.tsxpackages/frontend/src/components/VisualizationConfigs/ChartConfigPanel/Series/index.tsxpackages/visualization/src/cartesian/incompletePeriod.tspackages/common/src/utils/charts.tspackages/common/src/types/savedCharts.tsCloudy found this docs gap while working a support thread. Started from this internal Slack thread (Lightdash workspace only).
Add a top-N recipe to the table calculations docs
Pages
What changes
RANK/ROW_NUMBERtable calculation ordered descending, filtered to N or fewerPARTITION BYgives top N per group vs. top N overallWhy
Readers coming from other BI tools look for a top-N filter or chart option, and the pieces needed to build one with table calculations (RANK/ROW_NUMBER, then a filter) existed on separate pages with no recipe connecting them.
Checked against
packages/common/src/types/filter.tspackages/common/src/utils/filterLabels.tspackages/common/src/utils/i18n/uiStrings.tsCloudy found this docs gap while working a support thread. Started from this internal Slack thread (Lightdash workspace only).
Document what the AI Router sees, and a group-based way to skip it
Pages
What changes
Why
The AI Router page never said the router ignores the dashboard or chart a question is asked from, so admins wrote routing instructions that referenced a dashboard name and got the picker instead of automatic routing, with no documented alternative.
Checked against
packages/backend/src/ee/services/ai/agents/agentSelector.tspackages/backend/src/ee/services/AiRouterService/AiRouterService.tspackages/frontend/src/ee/features/aiCopilot/hooks/useAiAgentRouterFlow.tspackages/frontend/src/ee/features/aiCopilot/hooks/useAiRouter.tsCloudy found this docs gap while working a support thread. Started from this internal Slack thread (Lightdash workspace only).
Review pass: drop AI router grouping section and move chart-as-code reference
Pages
Removed
What changes
layout.showIncompletePeriodWhy
A reviewer asked to drop the new AI router section entirely and to move the chart-as-code field reference out of the chart configuration page into the content-as-code reference page.
Checked against
packages/common/src/types/savedCharts.tsReview closely
This is a larger change than usual:
A reviewer's comments on this pull request asked for this change. Started from this internal Slack thread (Lightdash workspace only).
Review pass: restore the Fewer than two agents bullet and Router and Slack heading
Pages
What changes
Why
An earlier cleanup commit removed the Fewer than two agents bullet and the Router and Slack heading along with the text the reviewer asked to drop; this restores them as main has them.
A reviewer's comments on this pull request asked for this change. Started from this internal Slack thread (Lightdash workspace only).