Update from code changes: document metrics catalog embedding#986
Open
mintlify[bot] wants to merge 1 commit into
Open
Update from code changes: document metrics catalog embedding#986mintlify[bot] wants to merge 1 commit into
mintlify[bot] wants to merge 1 commit into
Conversation
Contributor
🤖 Documentation Bot✅ All checks passed! No issues found. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documents the new metrics catalog embed surface so users know how to embed the project metrics catalog and configure Explore/write access on the token.
Changes
guides/embedding/metrics-catalog.mdxcovering when to use it, prerequisites, React SDK usage, and JWT config (includingcanExploreandwriteActions).Lightdash.MetricsCatalogsection to the React SDK reference with props, basic usage, and token generation.Metrics catalog tokensection to the embedding reference and includedmetricsCatalogin the sharedcontent.typeunion and "Known limitations" summary.docs.json.Context
Follows upstream lightdash/lightdash#25378 ("feat: metric catalog on embed"), which added the
metricsCatalogembed content type,Lightdash.MetricsCatalogSDK component, andcontent.canExploresupport on the new token.