Skip to content

docs: add pre-aggregate CLI audit reference#571

Merged
joaoviana merged 3 commits intomainfrom
docs/pre-aggregate-cli-audit
Apr 27, 2026
Merged

docs: add pre-aggregate CLI audit reference#571
joaoviana merged 3 commits intomainfrom
docs/pre-aggregate-cli-audit

Conversation

@joaoviana
Copy link
Copy Markdown
Contributor

Summary

  • Adds a new dedicated page CLI audit under references/pre-aggregates/ documenting the lightdash pre-aggregate-audit command (introduced in lightdash/packages/cli/src/handlers/preAggregateAudit.ts).
  • Covers when to use it, output statuses (hit / miss / ineligible), JSON mode for scripting, and a miss-reason → YAML-edit mapping table so users can iterate on coverage.
  • Documents --fail-on-miss for CI gating with a GitHub Actions example.
  • Links the new page from the pre-aggregates overview cards, the monitoring page (next to the in-app dashboard audit), and the CLI reference command list.

Test plan

  • mintlify dev renders /references/pre-aggregates/cli-audit correctly
  • Sidebar shows the new page under the Pre-aggregates group
  • Cross-links from monitoring.mdx, overview.mdx, and lightdash-cli.mdx resolve

🤖 Generated with Claude Code

Document the lightdash pre-aggregate-audit CLI command in a dedicated page
under the pre-aggregates section, covering when to use it, how each output
status maps back to YAML edits, and CI integration via --fail-on-miss. Add
the page to the navigation, link it from the dashboard audit tip in
monitoring.mdx, and list the command in the CLI reference.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented Apr 27, 2026

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

Project Status Preview Updated (UTC)
lightdash 🟢 Ready View Preview Apr 27, 2026, 11:23 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 27, 2026

🤖 Documentation Bot

All checks passed! No issues found.

The structured miss output (failing field + human reason on every line) is
exactly what coding agents like Cursor, Claude Code, and Codex need to
iterate on pre-aggregate YAML autonomously, so call that out explicitly.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 27, 2026

🤖 Documentation Bot

All checks passed! No issues found.

The miss-reason → fix table already lives on the monitoring page, so link
to it from the CLI page instead of restating the mapping. Keep the
iteration loop, which is unique to the CLI workflow.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 27, 2026

🤖 Documentation Bot

All checks passed! No issues found.

@joaoviana joaoviana merged commit 58392ec into main Apr 27, 2026
5 checks passed
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