feat: update embedding docs #263
Merged
Conversation
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
rephus
approved these changes
Dec 8, 2025
Contributor
rephus
left a comment
rephus
left a comment
There was a problem hiding this comment.
Looks good, there is a bit of duplicate content between charts/dashboards and how to embed (like secrets) , but that is ok.
Dashboard guide is particularly large because of all the examples, I guess that is fine.
Contributor
Author
|
I tried to be comprehensive. I'm also happy to trim it down. |
stevelikesmusic
force-pushed
the
12-05-feat_update_embedding_docs
branch
from
4148a65 to
990a4c7
Compare
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.
Closes: https://linear.app/lightdash/issue/CENG-199/embed-docs-for-all-embed-types
Updates embed docs to reflect current capabilities. We add additional pages to break up functionality into more logical and searchable pieces. This gives us the framework to add more embed types and capabilities in the future.
To review:
I didn't include any references for embed UI events because Rollstack is the only customer that has asked for this.
Claude gave me a good start—used Claude in the mintlify repo but pointed it at the lightdash repo for references. This could be a useful pattern on lightdash PRs where we open additional PRs here in the mintlify repo. I still had quite a bit to edit, but editing is much easier that writing from scratch.