diff --git a/docs/README.md b/docs/README.md index dbcbe4e930..4dcfc99fb8 100644 --- a/docs/README.md +++ b/docs/README.md @@ -69,6 +69,14 @@ and Direnv installed. This folder contains another `.envrc` file that adds all the binaries needed to build the docs to `$PATH`. +In short, when you `cd` into this folder, you should see this message: + +```sh +direnv: error wire-server/docs/.envrc is blocked. Run `direnv allow` to approve its content +``` + +Run `direnv allow` to allow the `.envrc` file to modify your environment, and you should then have all the binaries/correct environment needed to build the docs. + ### Generating html output (one-off) ```