Skip to content

Commit

Permalink
Merge pull request #18 from get-salt-AI/new-docs-theme-and-content
Browse files Browse the repository at this point in the history
New docs theme and content
  • Loading branch information
scottbaggett authored Jul 18, 2024
2 parents f1cf6d9 + 730abfc commit ce74236
Show file tree
Hide file tree
Showing 9 changed files with 47 additions and 9 deletions.
4 changes: 4 additions & 0 deletions docs/concepts.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
8 changes: 8 additions & 0 deletions docs/deploy-to-api.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
4 changes: 4 additions & 0 deletions docs/deploy-to-discord.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
4 changes: 4 additions & 0 deletions docs/deployments.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
description: Vew, manage, and monitor your deployed workflows.
---

# Managing Deployments in Salt AI

## Overview
Expand Down
4 changes: 4 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
4 changes: 4 additions & 0 deletions docs/model-import.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
4 changes: 4 additions & 0 deletions docs/nodes.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
4 changes: 4 additions & 0 deletions docs/workflows.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
20 changes: 11 additions & 9 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -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:
Expand Down Expand Up @@ -3903,10 +3903,8 @@ theme:

theme:
name: material
font:
text: Inter
code: 'Roboto Mono'
logo: images/[email protected]
icon: images/salt-logo-square.svg
favicon: images/favicon-light.png
features:
- navigation.instant
Expand All @@ -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
Expand All @@ -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
Expand All @@ -3952,3 +3952,5 @@ extra:
property: G-MHLEW2T4PQ
plugins:
- search
- tags
- social

0 comments on commit ce74236

Please sign in to comment.