Skip to content

docs: dashboard widgets#10744

Merged
keydunov merged 3 commits intomasterfrom
docs/dashboard-widgets
Apr 24, 2026
Merged

docs: dashboard widgets#10744
keydunov merged 3 commits intomasterfrom
docs/dashboard-widgets

Conversation

@keydunov
Copy link
Copy Markdown
Member

Check List

  • Tests have been run in packages where changes have been made if available
  • Linter has been run for changed code
  • Tests for the changes have been added if not covered yet
  • Docs have been added / updated if required

Documents the four dashboard widget types (Chart, Text/Markdown,
Control, AI) as dedicated pages under a new Widgets group, mirroring
the structure used by Omni's Tiles section. Also adds a package.json
for the Mintlify docs site so the dev server can be started with
`yarn dev` on port 3002.

Made-with: Cursor
- Use "dashboard builder" (the actual product term) instead of
  "dashboard editor"
- Split the Control page into separate Filter widget and Time Grain
  widget pages, matching the product's Add Filter / Add Time Grain
  toolbar buttons and the FILTER / TIME_GRAIN widget types
- Document the real way to add chart widgets (the Charts picker in
  the toolbar)
- Reflect the AI Widget label and Add AI Widget button used in the UI
- Update the product taxonomy rule with the Widget hierarchy under
  Dashboard builder so future docs use the same terms

Made-with: Cursor
- Use plural, widget-free titles in the sidebar: Charts, Text,
  Controls, AI summary
- Combine the separate Filter widget and Time grain switcher pages
  into a single Controls page with Filter and Time grain switcher
  sections
- Rename the AI page to AI summary and align the docs with the
  product rename of "AI Widget" / "Add AI Widget" to "AI Summary" /
  "Add AI Summary"
- Document filter / time grain switcher Visibility (Visible, Hidden,
  Disabled)
- Document Controls mapping: automatic mapping when dimensions
  match, manual remap or disable per chart from a chart's settings
  menu, time grain switchers restricted to time-typed dimensions,
  and the fact that AI agents configure these mappings when
  building dashboards
- Replace the bullet list of supported Markdown syntax on the Text
  page with a link to the Markdown Guide
- Update the namings rule to match the new widget taxonomy

Made-with: Cursor
@claude
Copy link
Copy Markdown
Contributor

claude Bot commented Apr 24, 2026

Claude finished @keydunov's task in 1m 45s —— View job


Review of PR #10744: docs: dashboard widgets

  • Gather context and read all changed files
  • Review documentation content and structure
  • Review navigation configuration (docs.json)
  • Check for unrelated/accidental changes
  • Post final review

Overall this is a well-structured addition of dashboard widget documentation. The content is clear, well-organized, and the navigation hierarchy makes sense. Here are my findings:

Issues to address

1. docs-mintlify/package.json and yarn.lock — likely unintended addition (7,200+ lines)

The PR adds a new docs-mintlify/package.json and a 7,197-line yarn.lock. These files didn't exist on master before. The root package.json workspaces config only covers packages/* and rust/*, so docs-mintlify/ is not part of the monorepo workspace.

This seems like a local development artifact that shouldn't be committed — the docs-mintlify/ directory likely uses Mintlify's hosted build pipeline rather than a local yarn install. If these files are intentional, they should be documented in the PR description. If not, they should be removed.

Fix this →

2. .cursor/rules/namings-rule.mdc — trailing whitespace on line 31

Line 31 has a trailing space after Controls:

          - Controls ← trailing space here

Minor, but worth cleaning up.

Fix this →

Suggestions (non-blocking)

3. controls.mdx[ref-granularities] link text is slightly misleading

In controls.mdx:98, the reference link [ref-granularities] points to /docs/data-modeling/dimensions, which is the general dimensions page. Since the text references "granularity" and "custom granularities defined in the data model," consider linking to a more specific anchor or section if one exists on that page, or noting it's the dimensions reference.

4. widgets/index.mdx — unused reference link

In widgets/index.mdx:19, the reference [ref-workbooks] is defined but never used in the page body. The dashboard builder mention on line 6 uses inline bracket syntax ([dashboard builder][ref-workbooks]) which does use it — so this is actually fine on closer look. Disregard.

5. Markdown link style is consistent — Good use of reference-style links ([text][ref-name]) throughout all new pages. All cross-references resolve to existing files.

What looks good

  • Navigation structure in docs.json is clean — the Dashboards > Widgets hierarchy with root pages follows the same pattern used elsewhere (e.g., Charts, Workbooks).
  • Content quality is strong — the controls page is particularly thorough with the operators table, faceted filters explanation, visibility settings, and controls mapping.
  • Product taxonomy update in .cursor/rules/namings-rule.mdc correctly mirrors the widget types documented in the new pages.
  • Dashboards index was properly refactored from a flat file (dashboards.mdx) to a directory with index.mdx to accommodate the new sub-pages.

Summary

The documentation content itself is excellent. The main concern is the package.json + yarn.lock addition (7,200+ lines / 96% of the diff) — please confirm whether these are intentional or should be removed.

@keydunov keydunov merged commit b879bea into master Apr 24, 2026
11 checks passed
@keydunov keydunov deleted the docs/dashboard-widgets branch April 24, 2026 01:18
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.

1 participant