From fb52c8767135c0ea472d4d1ff31f42daca6d93d6 Mon Sep 17 00:00:00 2001 From: Scott Baggett Date: Thu, 18 Jul 2024 00:01:25 -0400 Subject: [PATCH 1/2] feat: add social plugin --- mkdocs.yml | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index 5945c29c32..ec8d0291e3 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,14 +1,14 @@ -site_name: Documentation +site_name: Salt AI Docs +site_url: https://docs.getsalt.ai nav: - Getting Started: index.md - Core Concepts: concepts.md - Creating Workflows: workflows.md - Using Nodes: nodes.md - Managing Deployments: - - Deployments: deployments.md - - Deploy to API: deploy-to-api.md - - Deploy to Discord: deploy-to-discord.md - + - Deployments: deployments.md + - Deploy to API: deploy-to-api.md + - Deploy to Discord: deploy-to-discord.md - Advanced Topics: - Importing Models: model-import.md - Node Docs: @@ -3903,10 +3903,8 @@ theme: theme: name: material - font: - text: Inter - code: 'Roboto Mono' logo: images/salt-word@2x.png + icon: images/salt-logo-square.svg favicon: images/favicon-light.png features: - navigation.instant @@ -3921,6 +3919,9 @@ theme: - content.code.copy markdown_extensions: - tables + - pymdownx.emoji: + emoji_index: !!python/name:material.extensions.emoji.twemoji + emoji_generator: !!python/name:material.extensions.emoji.to_svg - pymdownx.highlight: anchor_linenums: true pygments_lang_class: true @@ -3939,7 +3940,6 @@ markdown_extensions: extra_css: - stylesheets/theme.css extra: - theme_dir: 'material' social: - icon: fontawesome/brands/github link: https://github.com/get-salt-AI @@ -3952,3 +3952,5 @@ extra: property: G-MHLEW2T4PQ plugins: - search + - tags + - social From 730abfcd594ed8a6fdc315c06e77a6e0ffbc8608 Mon Sep 17 00:00:00 2001 From: Scott Baggett Date: Thu, 18 Jul 2024 00:04:05 -0400 Subject: [PATCH 2/2] feat: updated meta descriptions --- docs/concepts.md | 4 ++++ docs/deploy-to-api.md | 8 ++++++++ docs/deploy-to-discord.md | 4 ++++ docs/deployments.md | 4 ++++ docs/index.md | 4 ++++ docs/model-import.md | 4 ++++ docs/nodes.md | 4 ++++ docs/workflows.md | 4 ++++ 8 files changed, 36 insertions(+) diff --git a/docs/concepts.md b/docs/concepts.md index 673ddc6cc5..2bdd34a873 100644 --- a/docs/concepts.md +++ b/docs/concepts.md @@ -1,3 +1,7 @@ +--- +description: This guide introduces you to the fundamental concepts and terminology you'll encounter while using our platform. +--- + # Salt AI: Core Concepts Welcome to Salt AI! This guide introduces you to the fundamental concepts and terminology you'll encounter while using our platform. Understanding these core concepts will help you navigate Salt AI more effectively and build powerful AI-driven applications. diff --git a/docs/deploy-to-api.md b/docs/deploy-to-api.md index 3fa81fd1cc..c981abdf1a 100644 --- a/docs/deploy-to-api.md +++ b/docs/deploy-to-api.md @@ -1,3 +1,11 @@ +--- +icon: material/rocket-launch-outline +social: + logo: docs/assets/images/salt-logo-square.svg + +description: The Deploy to API feature in Salt AI allows you to transform your workflows into production-ready APIs. +--- + # Deploying Workflows via Salt API ## Overview diff --git a/docs/deploy-to-discord.md b/docs/deploy-to-discord.md index dde5d87896..62fd4c3033 100644 --- a/docs/deploy-to-discord.md +++ b/docs/deploy-to-discord.md @@ -1,3 +1,7 @@ +--- +description: Salt AI offers a unique feature that allows you to deploy and run your workflows through the `Salt AI` Discord bot. +--- + # Deploying and Running Workflows on Discord Salt AI offers a unique feature that allows you to deploy and run your workflows through the `Salt AI` Discord bot. This guide will walk you through the process of deploying your workflows to Discord and using them within the Discord platform. diff --git a/docs/deployments.md b/docs/deployments.md index 66709efaa5..53f3e5ee43 100644 --- a/docs/deployments.md +++ b/docs/deployments.md @@ -1,3 +1,7 @@ +--- +description: Vew, manage, and monitor your deployed workflows. +--- + # Managing Deployments in Salt AI ## Overview diff --git a/docs/index.md b/docs/index.md index a9954331c6..a8e77ed071 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,3 +1,7 @@ +--- +description: Your go-to platform for building powerful AI-driven applications without writing a single line of code. +--- + # Getting Started with Salt AI Welcome to [Salt AI](https://getsalt.ai), your go-to platform for building powerful AI-driven applications without writing a single line of code. Salt AI offers an intuitive, node-based environment for creating sophisticated AI workflows. diff --git a/docs/model-import.md b/docs/model-import.md index 02e842a4eb..b7e6c897f8 100644 --- a/docs/model-import.md +++ b/docs/model-import.md @@ -1,3 +1,7 @@ +--- +description: Seamlessly upload models directly from Huggingface or CivitAI, streamlining your development process. +--- + # Importing Models Self service model importing is here! You can now seamlessly upload models directly from Huggingface or CivitAI, streamlining your development process. diff --git a/docs/nodes.md b/docs/nodes.md index a0b54b362e..38c8a1a147 100644 --- a/docs/nodes.md +++ b/docs/nodes.md @@ -1,3 +1,7 @@ +--- +description: Nodes are the fundamental building blocks of workflows in Salt AI. +--- + # Understanding Nodes in Salt AI Nodes are the fundamental building blocks of workflows in Salt AI. Each node represents a specific function or operation, allowing you to create complex AI applications through visual programming. This guide will help you understand what nodes are, how to use them, and how to leverage Salt AI's unique node features. diff --git a/docs/workflows.md b/docs/workflows.md index cd71e182bf..359393cbcd 100644 --- a/docs/workflows.md +++ b/docs/workflows.md @@ -1,3 +1,7 @@ +--- +description: Create powerful AI-driven applications through a visual, node-based interface. +--- + # Understanding Workflows in Salt AI Workflows are the heart of Salt AI, allowing you to create powerful AI-driven applications through a visual, node-based interface. This guide will help you understand what workflows are, how they function, and how to create effective workflows in Salt AI.