From 822469443342386b72c87390175be0c073dc21cc Mon Sep 17 00:00:00 2001 From: Fiiranek Date: Mon, 2 Dec 2024 16:37:44 +0100 Subject: [PATCH] Add full example of snippet configuration --- docs/src/development/shell-snippets.md | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/docs/src/development/shell-snippets.md b/docs/src/development/shell-snippets.md index 7e6819ccbf..bb91148408 100644 --- a/docs/src/development/shell-snippets.md +++ b/docs/src/development/shell-snippets.md @@ -6,10 +6,31 @@ To configure a snippet, you need to add a comment block right before it. The comment block should contain the configuration in JSON format. Example: -```markdown +`````markdown +```shell +$ sncast \ + account create \ + --url http://127.0.0.1:5055 \ + --name new_account ``` +
+Output: + +```shell +command: account create +add_profile: --add-profile flag was not set. No profile added to snfoundry.toml +address: [..] +max_fee: [..] +message: Account successfully created. Prefund generated address with at least STRK tokens or an equivalent amount of ETH tokens. It is good to send more in the case of higher demand. + +To see account creation details, visit: +account: https://sepolia.starkscan.co/contract/[..] +``` +
+````` + ## Available configuration options - `ignored` - if set to `true`, the snippet will be ignored and not run.