Skip to content

docs: document CLI write support for content verification#563

Merged
torimwhaley merged 2 commits intomainfrom
torimwhaley/cli-verified-content
Apr 23, 2026
Merged

docs: document CLI write support for content verification#563
torimwhaley merged 2 commits intomainfrom
torimwhaley/cli-verified-content

Conversation

@torimwhaley
Copy link
Copy Markdown
Contributor

Summary

Pairs with lightdash#22139, which adds a writable verified: boolean field to chart and dashboard YAML so users can verify/unverify content via lightdash upload.

  • guides/verified-content.mdx — replaces the "currently read-only" Note callout with full documentation of the new write capability:
    • Distinguishes the read-only verification audit block from the new writable verified boolean
    • Sample YAML showing both fields after lightdash download
    • Three-state behavior table (true / false / absent)
    • Permissions section explaining the warn-and-skip behavior for non-admin deployers (developer role, service accounts, custom roles without manage:ContentVerification)
    • Example workflow for promoting verified content between projects
  • guides/developer/dashboards-as-code.mdx — adds verification and verified fields to both YAML reference examples (dashboard and chart) with inline comments cross-linking to the verification guide. This way agents and skills reading the canonical YAML reference will see the verification fields as part of the standard structure.

Hold for merge

Don't merge this until lightdash#22139 is merged and released, otherwise the docs will claim a feature that isn't shipped.

Test plan

  • Preview build renders both pages cleanly (Mintlify auto-preview)
  • YAML code blocks display with proper syntax highlighting
  • Three-state behavior table renders correctly
  • /guides/verified-content cross-link from dashboards-as-code.mdx resolves
  • Manually verify all three states (true, false, absent) match the actual CLI behavior described in lightdash#22139 once that PR is merged

🤖 Generated with Claude Code

Update verified-content.mdx to remove the read-only caveat and document
the new `verified: boolean` field with three-state semantics
(true/false/absent), permissions behavior, and example workflow.

Add `verification` and `verified` fields to both YAML examples in
dashboards-as-code.mdx so the canonical YAML reference reflects what
users will see after `lightdash download`.

Pairs with lightdash#22139.

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

github-actions Bot commented Apr 22, 2026

🤖 Documentation Bot

All checks passed! No issues found.

@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented Apr 22, 2026

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

Project Status Preview Updated (UTC)
lightdash 🟢 Ready View Preview Apr 22, 2026, 6:24 PM

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

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

github-actions Bot commented Apr 22, 2026

🤖 Documentation Bot

All checks passed! No issues found.

@torimwhaley torimwhaley merged commit 9f99d63 into main Apr 23, 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