Skip to content

docs: move custom chart types out of data apps - #1107

Merged
almeidabbm merged 3 commits into
mainfrom
docs/custom-chart-types
Aug 12, 2026
Merged

docs: move custom chart types out of data apps#1107
almeidabbm merged 3 commits into
mainfrom
docs/custom-chart-types

Conversation

@almeidabbm

Copy link
Copy Markdown
Contributor

Data app visualizations shipped a proper entry point in Phase 1: their own gallery, their own builder, and settled vocabulary (GLITCH-643). The docs still described them as a kind of data app you create from a template card that no longer exists (GLITCH-648 removed it), so this rewrites them around what shipped.

What changed

guides/data-apps/visualizations is gone. Everything now lives in references/chart-types/custom-charts, which matches the UI: Custom is one menu entry covering two things.

  • ## Project chart types - the gallery, the builder, using one in a chart, saving and dashboards, permissions
  • ## Vega charts - the existing Vega content, now named Vega. Its limitations list is unchanged apart from saying "Vega charts" where it said "Custom Charts", which became ambiguous once Custom is the umbrella
  • ## Vega templates - untouched

No customer-facing prose calls these data apps any more. The two remaining mentions are load-bearing: the self-hosting requirement and the CLI local-development tip.

Also: redirect from the old path, nav entry removed, and inbound links fixed in chart-types/overview, guides/data-apps, guides/data-apps/maps, and both CLI reference mentions.

Draft because screenshots are pending

Three images are referenced but not yet on disk, so scripts/check-links.js reports them and the page will render broken until they land:

  • custom-chart-types-gallery.png - Browse -> Chart types, with a few cards
  • custom-chart-types-builder.png - sample-data preview, Configure panel, prompt bar, version chips
  • custom-chart-types-picker.png - Explorer config: Custom selected, picker showing Built in / Project, field mapping

custom-charts-drop-down.png also wants a retake in place - it shows the old dropdown, and the Quickstart step beside it now describes Custom -> Vega (JSON editor).

Once those land, eight orphaned files under images/guides/data-apps/visualization-*.png can be deleted.

Note for review

Nothing is said about embedding. Phase 0's scope says embedded dashboard tiles and standalone embedded charts render, but GLITCH-592 is still Todo in Phase 2, so I left it out rather than guess.

🤖 Generated with Claude Code

Chart types shipped their own gallery, builder and vocabulary, so the
docs no longer need to explain them as a kind of data app. Folding them
into the Custom charts reference puts them where people look for a chart
type, next to the Vega editor they share a menu entry with.

Screenshots for the gallery, builder and picker are still pending.
@mintlify

mintlify Bot commented Aug 12, 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 Aug 12, 2026, 4:12 PM

@github-actions

github-actions Bot commented Aug 12, 2026

Copy link
Copy Markdown
Contributor

🤖 Documentation Bot

Status

⚠️ 3 broken links need manual attention


🔗 Broken Links (Manual Fix Required)

Click to view details
   📄 references/chart-types/custom-charts.mdx:31 → /images/references/chart-types/custom-chart-types-gallery.png
   📄 references/chart-types/custom-charts.mdx:43 → /images/references/chart-types/custom-chart-types-builder.png
   📄 references/chart-types/custom-charts.mdx:69 → /images/references/chart-types/custom-chart-types-picker.png

The builder moved version history into a side panel behind History, so
the prose describing version chips no longer matched what ships.

Replaces the outdated Vega dropdown image and drops the eight
visualization-* images the old data apps page referenced.
@almeidabbm
almeidabbm marked this pull request as ready for review August 12, 2026 18:32
@almeidabbm

Copy link
Copy Markdown
Contributor Author

Screenshots are in, so this is out of draft. check-links.js and check-image-locations.js both pass.

Four images, all taken on a local instance at 1.144.0 in light mode:

  • custom-chart-types-gallery.png - the gallery with three chart types
  • custom-chart-types-builder.png - the builder with the History panel open on two versions, the Configure panel, and the prompt bar
  • custom-chart-types-picker.png - the picker open, showing the Built in / Project split and the footer actions
  • custom-chart-types-mapping.png - a chart type selected, inputs mapped, rendering on real data

custom-charts-drop-down.png was retaken in place. The old one still said Custom, but its chart type list predated Treemap, Sankey, Gauge and Map.

One prose fix

The repo moved from 1.132.0 to 1.144.0 while this was open, and 1cf5b49637 moved version history out of inline chips and into a side panel behind History. The page described the chips, so that sentence is corrected.

Worth knowing for whoever reviews: 123366d0e5 and 7d7ed123b2 shipped underlying data for these charts. The limitations section that would have been wrong was already removed from this branch.

Demo content

The three chart types (stream graph, calendar heatmap, bullet chart) were generated on the local instance for these shots and renamed to sentence case - the auto-generated names carried a "Visualization" suffix that echoes the vocabulary this PR is retiring.

@github-actions

github-actions Bot commented Aug 12, 2026

Copy link
Copy Markdown
Contributor

🤖 Documentation Bot

All checks passed! No issues found.

The page these replaced served light/dark pairs, and the reference pages
render in whichever theme the reader is on.
@github-actions

github-actions Bot commented Aug 12, 2026

Copy link
Copy Markdown
Contributor

🤖 Documentation Bot

All checks passed! No issues found.

@almeidabbm
almeidabbm merged commit 1312cf1 into main Aug 12, 2026
6 checks passed
@almeidabbm
almeidabbm deleted the docs/custom-chart-types branch August 12, 2026 18:46
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