From 1e5c274eaccc60cf2127e32aa1bee3d026af9bed Mon Sep 17 00:00:00 2001 From: Bryan Lee <38807139+liby@users.noreply.github.com> Date: Fri, 29 Nov 2024 10:34:52 +0800 Subject: [PATCH] docs(proto): Clarify PATH requirement for proto binary --- website/docs/proto/workflows.mdx | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/website/docs/proto/workflows.mdx b/website/docs/proto/workflows.mdx index bb31a0b974..431e1598b3 100644 --- a/website/docs/proto/workflows.mdx +++ b/website/docs/proto/workflows.mdx @@ -32,8 +32,9 @@ $ which node To make use of shims, prepend the `~/.proto/shims` directory to `PATH` in your shell profile. This _must come before_ the [bin directory](#binary-linking) if using both. -If you're using or plan to use [shell activation](#shell-activation), this happens automatically and -can be ignored. +If you're using or plan to use [shell activation](#shell-activation), the `PATH` configuration +happens automatically, but shell activation will only work if the `proto` command is accessible, +which requires `~/.proto/bin` to be in your `PATH`. ## Binary linking @@ -83,8 +84,9 @@ Node.js package managers currently do not support this, as JavaScript files are To make use of bins, prepend the `~/.proto/bin` directory to `PATH` in your shell profile. This _must come after_ the [shim directory](#shims) if using both. -If you're using or plan to use [shell activation](#shell-activation), this happens automatically and -can be ignored. +If you're using or plan to use [shell activation](#shell-activation), the `PATH` configuration +happens automatically, but shell activation will only work if the `proto` command is accessible, +which requires `~/.proto/bin` to be in your `PATH`. ## Shell activation