diff --git a/docs/building-your-quest/index.md b/docs/building-your-quest/index.md index 1bfd7e2..68e131f 100644 --- a/docs/building-your-quest/index.md +++ b/docs/building-your-quest/index.md @@ -66,6 +66,11 @@ frameworks: Frameworks this quest will be available in | optional - node frontend: - react +sidebarTools: A list of links to a tool that will be displayed on Snack(our chat) sidebar | optional + - name: tool 1 + link: https://tool1.com + - name: tool 2 + link: https://tool2.com ``` → [Start Repository] @@ -74,6 +79,7 @@ frameworks: Frameworks this quest will be available in | optional → [Quest Resources] +→ [Sidebar tools] [Steps]: {% link docs/building-your-quest/creating-steps.md %} [Assets]: {% link docs/building-your-quest/assets.md %} @@ -81,3 +87,4 @@ frameworks: Frameworks this quest will be available in | optional [Start Repository]: {% link docs/building-your-quest/repository.md %} [Supported Skills]: {% link docs/building-your-quest/supported-skills.md %} [Quest Resources]: {% link docs/building-your-quest/quest-resources/index.md %} +[Sidebar tools]: {% link docs/building-your-quest/sidebar-tools.md %} diff --git a/docs/building-your-quest/sidebar-tools.md b/docs/building-your-quest/sidebar-tools.md new file mode 100644 index 0000000..58bc713 --- /dev/null +++ b/docs/building-your-quest/sidebar-tools.md @@ -0,0 +1,25 @@ +--- +title: Sidebar Tools +parent: Building Your Quest +--- + +# Sidebar Tools +A sidebar tool is a link displayed in the Snack sidebar during a quest. It can be used to link to an external tool that is part of the quest. + +```yaml +sidebarTools: + - name: the name of tool that will be displayed on snack | mandatory + link: the URL that will be opened when clicking on the tool, can be a template string or a url | mandatory + visible: a template string to decide when to show the tool | optional + icon: a filename for an icon that is located in the assets folder | optional + enabled: a template string to decide when the tool is enabled | optional +``` +## Usage Example +```yaml +sidebarTools: + - name: External Tool + link: ${user.repository} + visible: ${user.properties.proptest} + icon: chat.svg + enabled: ${!!user.repository} +```