GRO-838 Adds support for _includes in docs src - #1295
Draft
bpander wants to merge 3 commits into
Draft
Conversation
bpander
force-pushed
the
gro-838-docs-includes
branch
from
August 24, 2026 17:14
d3538f0 to
3f6e2a3
Compare
bpander
marked this pull request as ready for review
August 24, 2026 18:21
iethree
approved these changes
Aug 24, 2026
iethree
left a comment
Contributor
There was a problem hiding this comment.
Very snazzy. Makes a lot of sense short term.
Longer term, instead of committing to liquid syntax, might we want to move to .mdx + react style components? If we do, does it make sense to support this in the docs only to refactor later?
Contributor
Author
I had the same thought last night. I also want to see what this looks like with mdx instead of having to support a new variable ( |
bpander
marked this pull request as draft
August 25, 2026 13:16
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.
GRO-838
Description
Allows includes from metabase docs src files so tech writers can reuse code that lives entirely in the mb repo.
Adding this to a [mb repo]/docs file will include [mb repo]/docs/_includes/test-md.md
Relevant slack thread
How to verify
script/docsshould not add frontmatter to _includes./script/docs -r "../metabase" --latest --update(-r is wherever your local metabase repo is)Demo
https://gro-838-docs-includes.dkkh35gceu2po.amplifyapp.com/docs/latest/embedding/authentication

https://gro-838-docs-includes.dkkh35gceu2po.amplifyapp.com/docs/v0.63/embedding/authentication
