diff --git a/README.md b/README.md index 2cf83a48b2..22e489b154 100644 --- a/README.md +++ b/README.md @@ -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. -Restart the dev server after changing `.env`. +If you change the `.env` file, restart the server. + +To serve all versions from `./_docs`, comment out `METABASE_REPO_PATH` in your `.env`.