Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add sidebar tools section #120

Merged
merged 1 commit into from
Jul 9, 2024
Merged

feat: add sidebar tools section #120

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/building-your-quest/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand All @@ -74,10 +79,12 @@ 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 %}
[Tests]: {% link docs/building-your-quest/tests.md %}
[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 %}
25 changes: 25 additions & 0 deletions docs/building-your-quest/sidebar-tools.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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}
```
Loading