Skip to content

Commit

Permalink
Merge pull request #5 from get-salt-AI/add-files-for-alex
Browse files Browse the repository at this point in the history
Adding files for Alex
  • Loading branch information
Alx-AI authored May 9, 2024
2 parents 195b137 + 743823f commit 0d31285
Show file tree
Hide file tree
Showing 5 changed files with 147 additions and 2 deletions.
19 changes: 19 additions & 0 deletions docs/Deployments.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Deployments

# **Deployments**

Salt currently supports deploying to Discord via the Salt AI bot.

When you’re ready to deploy, select the “Deploy” button in the top right corner. You will be prompted to give your workflow a name. Choose a unique, descriptive slug – your workflow will be discoverable by any Discord user using the Salt AI bot – then click “Deploy”.

[https://lh7-us.googleusercontent.com/VvmE3rThacE0EZ9bqJgqmJLvkqtBqggVIhh4YZUzOZZxcSKH7WsXifZksDweaeT0gBtvTGo7jImjsrLrG4epFfo57GJrhB4t1Wf_M0MFjtAWtUJsvJxkNuGTf0EJN1T8kC5t3rM41T72I_TbsUwKJ8I](https://lh7-us.googleusercontent.com/VvmE3rThacE0EZ9bqJgqmJLvkqtBqggVIhh4YZUzOZZxcSKH7WsXifZksDweaeT0gBtvTGo7jImjsrLrG4epFfo57GJrhB4t1Wf_M0MFjtAWtUJsvJxkNuGTf0EJN1T8kC5t3rM41T72I_TbsUwKJ8I)

You will see a confirmation screen when your deployment is complete. You can click to copy your workflow name to your clipboard.

You can manage and turn off your deployments at any time in the Deployments tab of your dashboard.

[https://lh7-us.googleusercontent.com/VV59k29PGDipaf3uDhahRxhGaN_EY-ZvhFPpj3mSNcnLt9CuyZKrswRf-Zu7g81yRponLlRHyKY8UayyjkM7h_dULS0RlS2KSUpIEHM2e8lF89RABEZjh9rh5lwBwucSbINlqEochH6eUQ8Vq1Cb_mg](https://lh7-us.googleusercontent.com/VV59k29PGDipaf3uDhahRxhGaN_EY-ZvhFPpj3mSNcnLt9CuyZKrswRf-Zu7g81yRponLlRHyKY8UayyjkM7h_dULS0RlS2KSUpIEHM2e8lF89RABEZjh9rh5lwBwucSbINlqEochH6eUQ8Vq1Cb_mg)

## **Need help?**

This guide is based on the beta version of Salt. Should you run into any issues or have questions, get in touch with our team via the [#support](https://discord.com/channels/1151592612525002822/1212167911771217961) channel in our Discord.
13 changes: 13 additions & 0 deletions docs/GettingStarted.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Getting Started

# **Getting Started**

Create your Salt account by selecting “Get started” in the top right hand corner of the homepage. You can choose to authenticate using your Google or Github account.

Once you’re logged in, you’ll be directed to the Workflows page.

Click “New Workflow” to start exploring the Workflow Editor.

[https://lh7-us.googleusercontent.com/zK__2sK6CkSnDfsd2s1TevyOYqsxhfzY-sIHa73eCUJKKGHUx97NrTmTdzg4w4U3UJFctavshat7YEcZuNtxuDHXjj0AacsvTYdvbJkn_gWQobDl1z0mcKfptIphWymlKoeqz0ghy3_bvjEfH4yX4II](https://lh7-us.googleusercontent.com/zK__2sK6CkSnDfsd2s1TevyOYqsxhfzY-sIHa73eCUJKKGHUx97NrTmTdzg4w4U3UJFctavshat7YEcZuNtxuDHXjj0AacsvTYdvbJkn_gWQobDl1z0mcKfptIphWymlKoeqz0ghy3_bvjEfH4yX4II)

Want to learn more about Workflows on Salt? Visit our Workflows help page.
35 changes: 35 additions & 0 deletions docs/UsingSaltinDiscord.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Using Salt in Discord

# **Using Salt in Discord**

Salt’s Discord integration lets you easily put your workflows in the hands of real users as lightweight applications with no front-end development required. Keep reading to learn how.

## Installing the Salt AI Discord bot

You can easily add the Salt AI bot to any server or to your own account (accessible by DM) by selecting the “Add to Server” button [here](https://discord.com/oauth2/authorize?client_id=1113909066587185274) or on the deployment confirmation screen.

[https://lh7-us.googleusercontent.com/IiqhuyPhOzJwEsjZYrIIFIdo6XxetN8FYZIoaCp5B9Kxl8PDrf57fI_jKPwEwcxlPDCthS5OEL5TkjLL1_t1n7MPkz04Rx3oVF9NM1R3GIrihU8fvg6sFZhN1dDvOLP0Oth70UmhZv1UwudNbNGsOZY](https://lh7-us.googleusercontent.com/IiqhuyPhOzJwEsjZYrIIFIdo6XxetN8FYZIoaCp5B9Kxl8PDrf57fI_jKPwEwcxlPDCthS5OEL5TkjLL1_t1n7MPkz04Rx3oVF9NM1R3GIrihU8fvg6sFZhN1dDvOLP0Oth70UmhZv1UwudNbNGsOZY)

[https://lh7-us.googleusercontent.com/lSEoSFz_RMuwjsZpXsBboXRn3jxIfSmiayBnvmhCZIhI2GJdFmUPzatIMnBcUTt8vLSjpu-6oTvJu3JJNQrWxQBRi6WjD76b0Q6SdzLPyXE9er9HH-l4qGFbO6houxkwi-IezMM7mSVUecrm55UPu_o](https://lh7-us.googleusercontent.com/lSEoSFz_RMuwjsZpXsBboXRn3jxIfSmiayBnvmhCZIhI2GJdFmUPzatIMnBcUTt8vLSjpu-6oTvJu3JJNQrWxQBRi6WjD76b0Q6SdzLPyXE9er9HH-l4qGFbO6houxkwi-IezMM7mSVUecrm55UPu_o)

## Running workflows in Discord

Once your workflow has been deployed to Discord, it is ready to be used by you and other users. Occasionally it can take several minutes to be discoverable in the Salt AI bot.

In any server with the Salt AI bot added, use the /workflows command to open the directory. You can enter the name of your workflow directly, copy and paste it, or simply type the /workflows command with your workflow’s name (example: “/workflow sample-workflow”) in the chat field to get started.

[https://lh7-us.googleusercontent.com/MLrXLPplvaBTNqUPSmsv0xwk1aCKKjXYKGSHPbYK5WHdjSS1dHcMPVpU9Fbobj0kC04gwV-ecV8OMEkPKg7yHag7IfKYBfQHFN6GTOqTXiTfND_DaPkvlt7GN7V5CtE3CzaIZgC7TCSBSUK344TlNaw](https://lh7-us.googleusercontent.com/MLrXLPplvaBTNqUPSmsv0xwk1aCKKjXYKGSHPbYK5WHdjSS1dHcMPVpU9Fbobj0kC04gwV-ecV8OMEkPKg7yHag7IfKYBfQHFN6GTOqTXiTfND_DaPkvlt7GN7V5CtE3CzaIZgC7TCSBSUK344TlNaw)

Once your workflow is selected, click “Run workflow” to open the prompt box. Enter your prompt and click “Submit”. Your output will be generated and appear in the thread or channel where you posted your message. You can also choose to set your workflow as your default every time you use the bot.

[https://lh7-us.googleusercontent.com/yMckfgzVwfS4LjdiCjBKMvezC4PJgtTAABXUYr9ntBK_VLORmp-xzDQdQSdB15B6f-4WbjfHQENZ7nCn1-seQvLZ1glQoS7-3A9PyS-a9wkrnhVxPl3LonRcS3A4nSsCj8zJLy_HpSzBJaXy-p7siuE](https://lh7-us.googleusercontent.com/yMckfgzVwfS4LjdiCjBKMvezC4PJgtTAABXUYr9ntBK_VLORmp-xzDQdQSdB15B6f-4WbjfHQENZ7nCn1-seQvLZ1glQoS7-3A9PyS-a9wkrnhVxPl3LonRcS3A4nSsCj8zJLy_HpSzBJaXy-p7siuE)

## Showcasing your workflows in the Salt catalog

To make your workflows discoverable to others in the community, first **[join the Salt Discord](https://discord.gg/saltai)** and complete onboarding.

Then, head to the **[#flow-catalog](https://discord.gg/FcbmPDf3E7)** channel and follow the example template to share your workflow. Be sure to run it using the Salt AI bot in a comment below and pin the comment, so others can easily grab and run it themselves.

## **Need help?**

This guide is based on the beta version of Salt. Should you run into any issues or have questions, get in touch with our team via the [#support](https://discord.com/channels/1151592612525002822/1212167911771217961) channel in our Discord.
76 changes: 76 additions & 0 deletions docs/Workflows.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
# Workflows

# Workflows

## Creating workflows

To create a new workflow, select “New Workflow” in the center of the default Workflows page, give your workflow a name, and select “Next”. A default sample workflow will automatically load.

You can quickly delete nodes by holding down CTRL CMD A to select all, then delete to clear the canvas. Double click anywhere on the canvas or right click and select “Add Node” to add nodes to your workflow.

[https://lh7-us.googleusercontent.com/RVhlealXcz3-f9-sji3qgl1O2jV22p1auOpbycV91k0m26guvzADuJ8rppdcNa0XelJZA5vkv6yL5qPkMlLNXW9vmXTPdv5VHkpHwLgACDw0faJgpejVXntM5cKV-qaPEIKdjG10D5TRnp3_nHdoshQ](https://lh7-us.googleusercontent.com/RVhlealXcz3-f9-sji3qgl1O2jV22p1auOpbycV91k0m26guvzADuJ8rppdcNa0XelJZA5vkv6yL5qPkMlLNXW9vmXTPdv5VHkpHwLgACDw0faJgpejVXntM5cKV-qaPEIKdjG10D5TRnp3_nHdoshQ)

[https://lh7-us.googleusercontent.com/hbr1ePw8aJFYWLZHrs7lWyNKd9yItQnJGh6yyRLbwjWvMAEultKCm9qKNUGzY-8EHcuXWy83C_Ig1d7n2Nr90M4tcHGw5XzQjEr0Pwju7F-FVby-Q-oZBvgerraz2UPqgVQ4j7qBmustafN-mUMu4-I](https://lh7-us.googleusercontent.com/hbr1ePw8aJFYWLZHrs7lWyNKd9yItQnJGh6yyRLbwjWvMAEultKCm9qKNUGzY-8EHcuXWy83C_Ig1d7n2Nr90M4tcHGw5XzQjEr0Pwju7F-FVby-Q-oZBvgerraz2UPqgVQ4j7qBmustafN-mUMu4-I)

## Working with Salt’s input and output nodes

Salt requires the use of special input and output nodes in every workflow. The **[SaltInput node](https://docs.getsalt.ai/md/SaltAI/Nodes/SaltInput/)** is required for passing an input into a workflow. The **[SaltOutput node](https://docs.getsalt.ai/md/SaltAI/Nodes/SaltOutput/)** is required in order to render an output (i.e. for all workflows).

More on working with SaltInput and SaltOutput nodes in the video below.

[https://drive.google.com/file/d/1CXSp4sypP9J0rbMztFE84VSg6Z8gq_-E/view?usp=drive_link](https://drive.google.com/file/d/1CXSp4sypP9J0rbMztFE84VSg6Z8gq_-E/view?usp=drive_link)

## Importing an existing workflow

To import an existing workflow to Salt, drag and drop it onto the page or press Command + V with the JSON copied to your clipboard.

## Running your workflow

Once you’re ready to run your workflow, click “Run” in the top right corner. Your workflow will be added to the queue.

[https://lh7-us.googleusercontent.com/dhPmixpJadWAfX1wM9PCK-OPQ4wEx6DT91p6EFbhklFuOfVGYCLqpe7QZ3NkDIGuq_CBaMQGUMQ0ZXtmAl3BfZ7XKmZwAcd4EcydsVbpAeq-2PqkrMBsejQ8_k4vxwTDlk3Ff5HcbJcFe3t37tiEQuM](https://lh7-us.googleusercontent.com/dhPmixpJadWAfX1wM9PCK-OPQ4wEx6DT91p6EFbhklFuOfVGYCLqpe7QZ3NkDIGuq_CBaMQGUMQ0ZXtmAl3BfZ7XKmZwAcd4EcydsVbpAeq-2PqkrMBsejQ8_k4vxwTDlk3Ff5HcbJcFe3t37tiEQuM)

You can track the status of your run in the status bar that appears in the top left corner, or by expanding the Jobs tab (seen below with a “1” badge).

[https://lh7-us.googleusercontent.com/kx3xG6za8Ja2i1GsTdwHBMsAd8cJOAqvTQNlNVX8fb_-ijtAilbYgHv85cbAYnnoprpO6_aAdTZ6R9thAkq-JhIfCXETaWe17KSb6OIlt6RnATDKCT2wlX1RV3xcM1ycQZQ7sWVab7fA9ShSvlVU6Xg](https://lh7-us.googleusercontent.com/kx3xG6za8Ja2i1GsTdwHBMsAd8cJOAqvTQNlNVX8fb_-ijtAilbYgHv85cbAYnnoprpO6_aAdTZ6R9thAkq-JhIfCXETaWe17KSb6OIlt6RnATDKCT2wlX1RV3xcM1ycQZQ7sWVab7fA9ShSvlVU6Xg)

To see your output, select the gallery icon to expand the Outputs tab. You can choose to download the JSON file for your output, download the output itself, open the image full screen in your browser and share a link, or delete it.

[https://lh7-us.googleusercontent.com/Mt6Gb5rcb8OB3NGux1lJ_fGGfpKrszM2uUbUoqC3lGqmRhql3EoKkkl42oWIvYllrWLKhgOf01eCr6mq_6Kh7m271WzcqGs95Z8xnHq_NbtlDhE5cZUJjRRiC2J9wQ2xOJFmtDZQAdGlD-ZmipuRf24](https://lh7-us.googleusercontent.com/Mt6Gb5rcb8OB3NGux1lJ_fGGfpKrszM2uUbUoqC3lGqmRhql3EoKkkl42oWIvYllrWLKhgOf01eCr6mq_6Kh7m271WzcqGs95Z8xnHq_NbtlDhE5cZUJjRRiC2J9wQ2xOJFmtDZQAdGlD-ZmipuRf24)

Identify any errors in your workflow by opening the Error logs, which appear at the bottom of your screen when expanded.

[https://lh7-us.googleusercontent.com/skCEOHlr9Q2ouAkj6hKIoHTELtoJDtcEiTjEOrtxtXXfkhR4_iLRVyZNWkaJ9EwGAaF2d2pB_n4VVqh6fcHHdh2RhybzfnIGFPqfTiPwkMLM0wc_6cxCnZUezK204tnzRFD4RkKwT0KjTj97xEICSWY](https://lh7-us.googleusercontent.com/skCEOHlr9Q2ouAkj6hKIoHTELtoJDtcEiTjEOrtxtXXfkhR4_iLRVyZNWkaJ9EwGAaF2d2pB_n4VVqh6fcHHdh2RhybzfnIGFPqfTiPwkMLM0wc_6cxCnZUezK204tnzRFD4RkKwT0KjTj97xEICSWY)

## Saving your workflow

Workflows automatically save as you go. You can find, open, and edit all of your workflows in the main Workflows page.

## Preparing your workflow for deployment

You can see a workflow’s inputs and outputs at the bottom of the screen. These count the number of SaltInput & SaltOutput nodes, which are the parameters exposed to the user when they run your deployed workflow through our API (currently the Salt Discord integration).

[https://lh7-us.googleusercontent.com/ksXmLwAMfMCjx4Pb7P9oPt8FTdqLRsO9iQv80XiRyRhJn8GgQSI9uRw5NiJdUQg2ubNGzSkD30gn4B4bAQ9y9bns8aGJF8xKd9EwLrfSWk953za4v7Z1ChNfHcUE2J3kBcQAelokFzGv8zLF-UJyZpE](https://lh7-us.googleusercontent.com/ksXmLwAMfMCjx4Pb7P9oPt8FTdqLRsO9iQv80XiRyRhJn8GgQSI9uRw5NiJdUQg2ubNGzSkD30gn4B4bAQ9y9bns8aGJF8xKd9EwLrfSWk953za4v7Z1ChNfHcUE2J3kBcQAelokFzGv8zLF-UJyZpE)

Use a SaltInput node for every parameter you want to expose to users who will be able to run your workflow, such as text inputs, seed number inputs, or an uploaded image or file.

You can use these in place of LoadImage nodes, or text boxes.

[https://lh7-us.googleusercontent.com/2w58IPsMxE6t93dI3t87uP_CcMj1fS1Vt7PHpI9h8wIZBsp4yz4-k-fG8nwB1_56n7OJcYTIkMh5om0uLPgzahkwtv26gfshQVpmHICqsoZDmLaETVOccuNF7X9ZkgoRUafUnsE0MTYF_4NcFjSaui8](https://lh7-us.googleusercontent.com/2w58IPsMxE6t93dI3t87uP_CcMj1fS1Vt7PHpI9h8wIZBsp4yz4-k-fG8nwB1_56n7OJcYTIkMh5om0uLPgzahkwtv26gfshQVpmHICqsoZDmLaETVOccuNF7X9ZkgoRUafUnsE0MTYF_4NcFjSaui8)

<aside>
💡 It’s a good idea to give your SaltInput nodes a unique name and description to help guide users of your workflow to know what that particular node should be used for (i.e. text prompt, uploaded image, etc.)

</aside>

You can plug a SaltInput node in place of a text box or node parameter by right-clicking the node and converting it to an input.

[https://lh7-us.googleusercontent.com/brB4YI4TddHJ_mCZvu-fgoQIz5xAaSAvaJxg5J70yOP2zj4wxawwmc3OO-j1c71odFxxbEPeWWS6BvUOKxEU8xqfgnsU1W5FO2DldSNXXkYsD-UWqxxuvhtkGNerht6sBQXEmpI7GiAd07V9ufESn8w](https://lh7-us.googleusercontent.com/brB4YI4TddHJ_mCZvu-fgoQIz5xAaSAvaJxg5J70yOP2zj4wxawwmc3OO-j1c71odFxxbEPeWWS6BvUOKxEU8xqfgnsU1W5FO2DldSNXXkYsD-UWqxxuvhtkGNerht6sBQXEmpI7GiAd07V9ufESn8w)

Your outputs can be configured using SaltOutput nodes, which is where you are able to specify your file types & frame rate. Each node can handle batch outputs, and you can have multiple nodes with different file types. It can help to name your outputs to differentiate them.

[https://lh7-us.googleusercontent.com/21gCV-ojxoqlHtdoOzznrqRkTK8jiMYW4JZ1IXCWiGAlSci85viJoeieYyoS5jgrsSWrCUkWKZHoOIaTqAdMrRfcnO9ocq7TNVqPt-Aj00aANlC3NLK4q0DrCLptuc6ocdys6KEoVeThowPz-e9EhcY](https://lh7-us.googleusercontent.com/21gCV-ojxoqlHtdoOzznrqRkTK8jiMYW4JZ1IXCWiGAlSci85viJoeieYyoS5jgrsSWrCUkWKZHoOIaTqAdMrRfcnO9ocq7TNVqPt-Aj00aANlC3NLK4q0DrCLptuc6ocdys6KEoVeThowPz-e9EhcY)

## **Need help?**

This guide is based on the beta version of Salt. Should you run into any issues or have questions, get in touch with our team via the [#support](https://discord.com/channels/1151592612525002822/1212167911771217961) channel in our Discord.
6 changes: 4 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
site_name: Salt Documentation
nav:
- Getting Started: index.md
- Platform Resources: resources.md
- Getting Started: GettingStarted.md
- Workflows: Workflows.md
- Deployments: Deployments.md
- Using Salt in Discord: UsingSaltinDiscord.md
- Node Documentation:
- Home: md/index.md
- Tags: md/tags.md
Expand Down

0 comments on commit 0d31285

Please sign in to comment.