Skip to content

update README.md #1318

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jeff-bruemmer merged 2 commits into from
Sep 2, 2026
Merged

update README.md #1318

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
267694d
update README.md
jeff-bruemmer Sep 2, 2026
a4b6803
Apply suggestion from @jeff-bruemmer
jeff-bruemmer Sep 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ cp .env-dist .env

Point `METABASE_REPO_PATH` at your local Metabase repo (defaults to `../metabase`, i.e. it assumes the repo is a sibling of this one).

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.
Comment thread
jeff-bruemmer marked this conversation as resolved.

Restart the dev server after changing `.env`.

@bpander bpander Sep 2, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

If you change the `.env` file, restart the server.

To serve all versions from `./_docs`, comment out `METABASE_REPO_PATH` in your `.env`.