From bfdc7732bbd6b4af6faef2dbd7d5d663e6b29135 Mon Sep 17 00:00:00 2001 From: Jonas da Silva Date: Sat, 12 Oct 2024 11:33:03 +0200 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Improve=20plugins=20docs?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- manual/src/plugins.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/manual/src/plugins.md b/manual/src/plugins.md index e1ba3bb..bc9ec62 100644 --- a/manual/src/plugins.md +++ b/manual/src/plugins.md @@ -22,10 +22,11 @@ the paths in the temporary directory ("prebuilt directory"). - `ALLAY_DEBUG` --- Whether the project is built in debug mode. - `ALLAY_PREBUILD` --- The root of the prebuilt directory. -- `ALLAY_PROJECT_ROOT` --- The root of the project root (the directory with the `allay.toml` file). +- `ALLAY_PROJECT_ROOT` --- The path to the root of the project (the directory with the `allay.toml` file). - `ALLAY_VERSION` --- The version of Allay that is beeing used. -On top of that users may define extra environment variables in the [`[env]`](./configuration.md#env) section of the configuration file. +On top of that users may define extra environment variables in the +[`[env]`](./configuration.md#the-env-section) section of the configuration file. ### Configuration @@ -77,7 +78,7 @@ To tell Ally to run this plugin, we need to mention it in the `allay.toml` file. # ... [[plugin]] -run = "scripts/info.py" +run = "plugins/info.py" with = "python3" ``` @@ -95,7 +96,7 @@ adding the `when` field: # ... [[plugin]] -run = "scripts/info.py" +run = "plugins/info.py" with = "python3" when = 'env("ALLAY_DEBUG") == "1"' ```