Skip to content

Add "Building data apps locally" guide - #1071

Merged
magnew merged 2 commits into
mainfrom
mintlify/6c8c8be9
Aug 3, 2026
Merged

Add "Building data apps locally" guide#1071
magnew merged 2 commits into
mainfrom
mintlify/6c8c8be9

Conversation

@mintlify

@mintlify mintlify Bot commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

Adds a new guide at guides/data-apps/building-locally.mdx covering the full local workflow for data apps: download → edit → preview → upload, lightdash apps create, slug identity, versioning, dashboard linkage, local preview, external connections, the server build, and experimental custom dependencies.

Also fixes existing docs that were out of date:

  • guides/data-apps.mdx — the "Data apps as code" section is trimmed to a short teaser that links to the new guide. All UUID-keyed, "manifest is source of truth", retarget-manifest content is removed.
  • references/lightdash-cli.mdx — updated to reflect slug-based identity, added lightdash apps create and lightdash apps preview command sections, refreshed the --apps / --include-apps flags on both download and upload, added --apps-limit, --external-connections / --include-external-connections, and updated the examples.
  • docs.json — new page added to the Data apps group.

Open items (called out in the guide with a note or left for follow-up):

  • Prerequisites currently reads "You need a version with slug-based app identity and the apps create / apps preview commands — run lightdash --version and upgrade if you're on an older release." Swap in the actual first CLI version once known.
  • Custom-dependency feature-flag request path is stated as "contact Lightdash support (or your admin, on self-hosted instances)". Confirm or replace with a self-serve path if one exists.
  • Cross-project upload behavior is documented as a plain slug upsert with no prompt. Worth a manual sanity check against current CLI + server before publishing widely.
  • CLI reference tables from the draft are represented as links back to /references/lightdash-cli sections rather than duplicated on the guide, to avoid two sources of truth. Happy to duplicate them on the guide page if you prefer.

Validated with mint validate and mint broken-links — both pass.


Generated by Mintlify Agent.

Requested by: marshall@lightdash.com via Slack
Mintlify session: slack_1785764149.136529_C0A3PQ0B2HZ

@mintlify

mintlify Bot commented Aug 3, 2026

Copy link
Copy Markdown
Contributor Author

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

Project Status Preview Updated (UTC)
lightdash 🟢 Ready View Preview Aug 3, 2026, 1:42 PM

@github-actions

github-actions Bot commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

🤖 Documentation Bot

All checks passed! No issues found.

@github-actions

github-actions Bot commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

🤖 Documentation Bot

All checks passed! No issues found.

@magnew
magnew merged commit 82588be into main Aug 3, 2026
6 checks passed
@magnew
magnew deleted the mintlify/6c8c8be9 branch August 3, 2026 15:52
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