From 267694dfc40e81d86ba059d30b27dc59dc2c0c66 Mon Sep 17 00:00:00 2001 From: Jeff Bruemmer Date: Wed, 2 Sep 2026 15:12:54 -0400 Subject: [PATCH 1/2] update README.md Clarified the behavior of METABASE_REPO_PATH and its effect on serving documentation. --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2cf83a48b2..7411569aee 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,6 @@ 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. -Restart the dev server after changing `.env`. +To serve all versions from `./_docs`, comment out `METABASE_REPO_PATH` in your `.env`. From a4b6803c058e0199b028c5ea564895701d2062c5 Mon Sep 17 00:00:00 2001 From: Jeff Bruemmer Date: Wed, 2 Sep 2026 15:22:52 -0400 Subject: [PATCH 2/2] Apply suggestion from @jeff-bruemmer --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 7411569aee..22e489b154 100644 --- a/README.md +++ b/README.md @@ -21,4 +21,6 @@ Point `METABASE_REPO_PATH` at your local Metabase repo (defaults to `../metabase 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. +If you change the `.env` file, restart the server. + To serve all versions from `./_docs`, comment out `METABASE_REPO_PATH` in your `.env`.