Skip to content

docs: add data app visualizations guide#929

Open
almeidabbm wants to merge 2 commits into
mainfrom
docs/data-app-visualizations
Open

docs: add data app visualizations guide#929
almeidabbm wants to merge 2 commits into
mainfrom
docs/data-app-visualizations

Conversation

@almeidabbm

Copy link
Copy Markdown
Contributor

Summary

Adds user-facing documentation for data app visualizations - AI-generated, reusable custom chart types built on the data apps infrastructure.

  • New guide page guides/data-apps/visualizations covering:
    • Creating a visualization from the Data app visualization template card in the app generator (prompt -> renderer + declared field schema)
    • Testing it with real data via the interactive "Visualization ready" test panel (ephemeral, no saved chart)
    • Using it as a chart type in the Explorer: searchable visualization dropdown + field mapping (required fields can't be cleared)
    • Saving and dashboards: saved charts remember the visualization + mapping; dashboard filters and date zoom apply; one visualization reused across many charts
    • Permissions cross-link to the existing data apps permissions section
  • Linked from the data apps landing page (new "Visualizations" section)
  • Short entry on the chart types overview alongside Custom chart, noting it requires data apps to be enabled
  • Registered in the nav (docs.json)

Screenshots are left as TODO Frame placeholders for: template picker card, test panel, Explorer chart-type picker + field mapping, and a dashboard tile.

Display config options (colors, toggles) are intentionally not documented - that UI has not shipped yet.

Verification

  • mint broken-links passes; the only flagged links are the 4 intentional TODO image placeholders.
  • docs.json validates as JSON.

🤖 Generated with Claude Code

Documents the new AI-generated reusable chart types built on data apps: creating a visualization from the template card, testing it with real data, using it as a chart type in the Explorer with field mapping, and saving/dashboard behavior. Links it from the data apps landing page and the chart types overview, and registers it in the nav.
@github-actions

github-actions Bot commented Jul 3, 2026

Copy link
Copy Markdown
Contributor

🤖 Documentation Bot

Status

⚠️ 4 broken links need manual attention


🔗 Broken Links (Manual Fix Required)

Click to view details
   📄 guides/data-apps/visualizations.mdx:24 → /images/TODO-data-app-viz-template-card.png
   📄 guides/data-apps/visualizations.mdx:42 → /images/TODO-data-app-viz-test-panel.png
   📄 guides/data-apps/visualizations.mdx:59 → /images/TODO-data-app-viz-explorer-config.png
   📄 guides/data-apps/visualizations.mdx:71 → /images/TODO-data-app-viz-dashboard-tile.png

@mintlify

mintlify Bot commented Jul 3, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
lightdash 🟢 Ready View Preview Jul 3, 2026, 9:28 AM

Replaces the four TODO Frame placeholders with real captures from a local instance: template picker card, Visualization ready test panel, Explorer chart config with field mapping, and a dashboard tile. Each Frame has light and dark variants following the existing dark:hidden/dark:block pattern.
@github-actions

github-actions Bot commented Jul 3, 2026

Copy link
Copy Markdown
Contributor

🤖 Documentation Bot

All checks passed! No issues found.

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