update README.md - #1318
Merged
Merged
Conversation
Clarified the behavior of METABASE_REPO_PATH and its effect on serving documentation.
bpander
approved these changes
Sep 2, 2026
| With `METABASE_REPO_PATH` set, `/docs/latest` serves and hot-reloads files from your local Metabase repo, and only `/latest` routes are available — earlier versions 404. Comment it out to serve all versions from `./_docs` instead. | ||
| With `METABASE_REPO_PATH` set, `/docs/latest` serves your current branch (NOT the latest branch), and hot-reloads files from your local Metabase repo. Only `/latest` routes are available, which again, are the docs from whatever branch your Metabase repo is on. | ||
|
|
||
| Restart the dev server after changing `.env`. |
Contributor
There was a problem hiding this comment.
We might want to keep the "Restart the dev server after changing .env." line. At least in my testing, I was changing it a bunch, and it behaved much more predictably if I restarted the dev server after saving .env changes.
jeff-bruemmer
commented
Sep 2, 2026
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
2 participants
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.
Clarified the behavior of METABASE_REPO_PATH and its effect on serving documentation.