mirror of
https://github.com/simstudioai/sim.git
synced 2026-02-19 02:34:37 -05:00
feat(docs): added more docs, cleaned up
This commit is contained in:
Waleed Latif
@@ -6,6 +6,7 @@ description: Building blocks for your agentic workflows
|
||||
import { Card, Cards } from 'fumadocs-ui/components/card'
|
||||
import { Tabs, Tab } from 'fumadocs-ui/components/tabs'
|
||||
import { Steps, Step } from 'fumadocs-ui/components/steps'
|
||||
import { BlockTypes } from '@/components/ui/block-types'
|
||||
|
||||
Blocks are the fundamental building components of Sim Studio workflows. Each block has a specific purpose and can be connected to other blocks to create sophisticated workflows.
|
||||
|
||||
@@ -17,88 +18,7 @@ A block is a reusable, configurable component that performs a specific function
|
||||
|
||||
Sim Studio provides six powerful block types that form the foundation of any workflow. Each block is designed to handle specific aspects of your agentic applications, from AI-powered reasoning to conditional logic and external integrations.
|
||||
|
||||
<Tabs items={['Grid View', 'Card View']}>
|
||||
<Tab>
|
||||
<div className="grid grid-cols-2 md:grid-cols-3 gap-4 my-6">
|
||||
<div className="border border-gray-200 dark:border-gray-800 rounded-lg p-4">
|
||||
<h3 className="font-medium text-lg mb-2">Agent</h3>
|
||||
<div className="text-sm text-gray-600 dark:text-gray-400">
|
||||
Create powerful AI agents using any LLM provider
|
||||
</div>
|
||||
</div>
|
||||
<div className="border border-gray-200 dark:border-gray-800 rounded-lg p-4">
|
||||
<h3 className="font-medium text-lg mb-2">API</h3>
|
||||
<div className="text-sm text-gray-600 dark:text-gray-400">
|
||||
Connect to external services through HTTP requests
|
||||
</div>
|
||||
</div>
|
||||
<div className="border border-gray-200 dark:border-gray-800 rounded-lg p-4">
|
||||
<h3 className="font-medium text-lg mb-2">Condition</h3>
|
||||
<div className="text-sm text-gray-600 dark:text-gray-400">
|
||||
Branch workflow execution based on boolean expressions
|
||||
</div>
|
||||
</div>
|
||||
<div className="border border-gray-200 dark:border-gray-800 rounded-lg p-4">
|
||||
<h3 className="font-medium text-lg mb-2">Function</h3>
|
||||
<div className="text-sm text-gray-600 dark:text-gray-400">
|
||||
Execute custom JavaScript or TypeScript code
|
||||
</div>
|
||||
</div>
|
||||
<div className="border border-gray-200 dark:border-gray-800 rounded-lg p-4">
|
||||
<h3 className="font-medium text-lg mb-2">Evaluator</h3>
|
||||
<div className="text-sm text-gray-600 dark:text-gray-400">
|
||||
Assess content quality using customizable metrics
|
||||
</div>
|
||||
</div>
|
||||
<div className="border border-gray-200 dark:border-gray-800 rounded-lg p-4">
|
||||
<h3 className="font-medium text-lg mb-2">Router</h3>
|
||||
<div className="text-sm text-gray-600 dark:text-gray-400">
|
||||
Intelligently direct workflow execution
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</Tab>
|
||||
<Tab>
|
||||
<Cards>
|
||||
<Card
|
||||
title="Agent"
|
||||
href="/docs/blocks/agent"
|
||||
description="Create powerful AI agents using any LLM provider with customizable system prompts and tool integrations."
|
||||
icon="🤖"
|
||||
/>
|
||||
<Card
|
||||
title="API"
|
||||
href="/docs/blocks/api"
|
||||
description="Connect to any external API with support for all standard HTTP methods and customizable request parameters."
|
||||
icon="🔌"
|
||||
/>
|
||||
<Card
|
||||
title="Condition"
|
||||
href="/docs/blocks/condition"
|
||||
description="Add a condition to the workflow to branch the execution path based on a boolean expression."
|
||||
icon="🔀"
|
||||
/>
|
||||
<Card
|
||||
title="Function"
|
||||
href="/docs/blocks/function"
|
||||
description="Execute custom JavaScript or TypeScript code within your workflow to transform data or implement complex logic."
|
||||
icon="⚙️"
|
||||
/>
|
||||
<Card
|
||||
title="Evaluator"
|
||||
href="/docs/blocks/evaluator"
|
||||
description="Assess content quality using customizable evaluation metrics and scoring criteria."
|
||||
icon="📊"
|
||||
/>
|
||||
<Card
|
||||
title="Router"
|
||||
href="/docs/blocks/router"
|
||||
description="Intelligently direct workflow execution to different paths based on input analysis."
|
||||
icon="🔄"
|
||||
/>
|
||||
</Cards>
|
||||
</Tab>
|
||||
</Tabs>
|
||||
<BlockTypes />
|
||||
|
||||
## Block Connections
|
||||
|
||||
|
||||
5
docs/content/docs/connections/index.mdx
Normal file
5
docs/content/docs/connections/index.mdx
Normal file
@@ -0,0 +1,5 @@
|
||||
---
|
||||
title: Connections
|
||||
description: Connect your blocks to one another.
|
||||
---
|
||||
|
||||
5
docs/content/docs/execution/index.mdx
Normal file
5
docs/content/docs/execution/index.mdx
Normal file
@@ -0,0 +1,5 @@
|
||||
---
|
||||
title: Execution
|
||||
description: The execution of a workflow.
|
||||
---
|
||||
|
||||
@@ -6,7 +6,9 @@ description: Build, test, and optimize your agentic workflows
|
||||
import { Card, Cards } from 'fumadocs-ui/components/card'
|
||||
import { Steps, Step } from 'fumadocs-ui/components/steps'
|
||||
import { Callout } from 'fumadocs-ui/components/callout'
|
||||
import { Files, Folder, File } from 'fumadocs-ui/components/files'
|
||||
import { Tabs, Tab } from 'fumadocs-ui/components/tabs'
|
||||
import { AgentIcon, ApiIcon, ConditionalIcon, CodeIcon, ChartBarIcon, ConnectIcon, GmailIcon, PerplexityIcon, NotionIcon, ExaAIIcon, FirecrawlIcon, SlackIcon } from '@/components/icons'
|
||||
|
||||
Sim Studio is a powerful, user-friendly platform for building, testing, and optimizing your agentic workflows. This documentation will help you understand how to use the various components of Sim Studio to create sophisticated agent-based applications.
|
||||
|
||||
@@ -14,24 +16,35 @@ Sim Studio is a powerful, user-friendly platform for building, testing, and opti
|
||||
This guide will walk you through the essential concepts and help you get started building your first workflow.
|
||||
</Callout>
|
||||
|
||||
## Core Concepts
|
||||
## Core Components
|
||||
|
||||
Sim Studio is built around two fundamental concepts:
|
||||
Sim Studio is built around two primary components:
|
||||
|
||||
<Cards>
|
||||
<Card
|
||||
title="Blocks"
|
||||
href="/docs/blocks"
|
||||
description="The building blocks of your workflows - Agent, Router, Evaluator, Condition, Function, and API blocks that can be connected together."
|
||||
icon="🧩"
|
||||
/>
|
||||
<Card
|
||||
title="Tools"
|
||||
href="/docs/tools"
|
||||
description="Specialized functionality that can be used standalone or integrated within blocks to extend capabilities."
|
||||
icon="🔧"
|
||||
/>
|
||||
</Cards>
|
||||
### Blocks
|
||||
|
||||
Blocks are the fundamental building elements of your workflows. Each block serves a specific purpose:
|
||||
|
||||
<Files>
|
||||
<File name="Agent Block" icon={<AgentIcon className="w-4 h-4" />} annotation="Create AI agents using any LLM provider" />
|
||||
<File name="API Block" icon={<ApiIcon className="w-4 h-4" />} annotation="Connect to external services and APIs" />
|
||||
<File name="Condition Block" icon={<ConditionalIcon className="w-4 h-4" />} annotation="Add conditional branching to your workflows" />
|
||||
<File name="Function Block" icon={<CodeIcon className="w-4 h-4" />} annotation="Execute custom JavaScript/TypeScript code" />
|
||||
<File name="Evaluator Block" icon={<ChartBarIcon className="w-4 h-4" />} annotation="Assess responses against defined criteria" />
|
||||
<File name="Router Block" icon={<ConnectIcon className="w-4 h-4" />} annotation="Direct workflow execution based on input analysis" />
|
||||
</Files>
|
||||
|
||||
### Tools
|
||||
|
||||
Tools extend the capabilities of agents. They provide additional functionality for agents by enabling you to interface with your favorite data sources and take action (e.g posting on X, sending an email)
|
||||
|
||||
<Files>
|
||||
<File name="Gmail Tool" icon={<GmailIcon className="w-4 h-4" />} />
|
||||
<File name="Firecrawl Tool" icon={<FirecrawlIcon className="w-4 h-4" />} />
|
||||
<File name="Perplexity Tool" icon={<PerplexityIcon className="w-4 h-4" />} />
|
||||
<File name="Notion Tool" icon={<NotionIcon className="w-4 h-4" />} />
|
||||
<File name="Exa AI Tool" icon={<ExaAIIcon className="w-4 h-4" />} />
|
||||
<File name="Slack Tool" icon={<SlackIcon className="w-4 h-4" />} />
|
||||
</Files>
|
||||
|
||||
## Getting Started
|
||||
|
||||
@@ -51,57 +64,4 @@ Sim Studio is built around two fundamental concepts:
|
||||
<Step title="Test your workflow">
|
||||
Run your workflow with test inputs to verify its behavior.
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
## Explore Blocks
|
||||
|
||||
<Tabs items={['Agent Blocks', 'Logic Blocks', 'Integration Blocks']}>
|
||||
<Tab>
|
||||
<Cards>
|
||||
<Card
|
||||
title="Agent"
|
||||
href="/docs/blocks/agent"
|
||||
description="Create AI agents that can process inputs and generate outputs based on instructions."
|
||||
icon="🤖"
|
||||
/>
|
||||
<Card
|
||||
title="Evaluator Block"
|
||||
href="/docs/blocks/evaluator"
|
||||
description="Evaluate agent responses against specific criteria."
|
||||
icon="📊"
|
||||
/>
|
||||
</Cards>
|
||||
</Tab>
|
||||
<Tab>
|
||||
<Cards>
|
||||
<Card
|
||||
title="Router Block"
|
||||
href="/docs/blocks/router"
|
||||
description="Route workflow execution based on specific conditions."
|
||||
icon="🔄"
|
||||
/>
|
||||
<Card
|
||||
title="Condition Block"
|
||||
href="/docs/blocks/condition"
|
||||
description="Create conditional logic to control workflow execution paths."
|
||||
icon="🔀"
|
||||
/>
|
||||
</Cards>
|
||||
</Tab>
|
||||
<Tab>
|
||||
<Cards>
|
||||
<Card
|
||||
title="Function Block"
|
||||
href="/docs/blocks/function"
|
||||
description="Execute custom JavaScript/TypeScript functions."
|
||||
icon="⚙️"
|
||||
/>
|
||||
<Card
|
||||
title="API Block"
|
||||
href="/docs/blocks/api"
|
||||
description="Make API calls to external services."
|
||||
icon="🔌"
|
||||
/>
|
||||
</Cards>
|
||||
</Tab>
|
||||
</Tabs>
|
||||
</Steps>
|
||||
@@ -1,87 +1,24 @@
|
||||
---
|
||||
title: Introduction
|
||||
description: A powerful platform for building, testing, and optimizing agentic workflows
|
||||
description: Introduction to Sim Studio
|
||||
---
|
||||
|
||||
import { Card, Cards } from 'fumadocs-ui/components/card'
|
||||
import { Files, Folder, File } from 'fumadocs-ui/components/files'
|
||||
import { Callout } from 'fumadocs-ui/components/callout'
|
||||
import { Features } from '@/components/ui/features'
|
||||
|
||||
Sim Studio is a powerful platform for building, testing, and optimizing agentic workflows. It provides developers with intuitive tools to design sophisticated agent-based applications through a visual interface. Whether you're prototyping a simple AI assistant or building complex multi-agent systems, Sim Studio offers the flexibility and performance needed for modern AI applications.
|
||||
|
||||
## Why Sim Studio?
|
||||
|
||||
<Callout>
|
||||
Building agentic applications has traditionally required extensive coding and integration work. Developers often find themselves spending more time on infrastructure and plumbing rather than focusing on the core AI logic. Sim Studio changes this by providing a comprehensive visual workflow editor that handles the complexity while keeping you in control of what matters.
|
||||
</Callout>
|
||||
Building agentic applications has traditionally required extensive coding and integration work. Developers often find themselves spending more time on infrastructure and plumbing rather than focusing on the core AI logic. Sim Studio changes this by providing a comprehensive visual workflow editor that handles the complexity while keeping you in control of what matters.
|
||||
|
||||
## Features
|
||||
|
||||
Sim Studio provides a wide range of features designed to accelerate your development process:
|
||||
|
||||
<Cards>
|
||||
<Card
|
||||
title="Visual Workflow Editor"
|
||||
description="Build complex workflows using a drag-and-drop interface with real-time previews"
|
||||
icon="📊"
|
||||
/>
|
||||
<Card
|
||||
title="Modular Building Blocks"
|
||||
description="Compose workflows using pre-built blocks for agents, APIs, functions, and more"
|
||||
icon="🧩"
|
||||
/>
|
||||
<Card
|
||||
title="Multiple LLM Support"
|
||||
description="Connect to various LLM providers and models with built-in optimization"
|
||||
icon="🤖"
|
||||
/>
|
||||
<Card
|
||||
title="Testing & Debugging"
|
||||
description="Test workflows with simulated inputs and debug with detailed execution logs"
|
||||
icon="🔍"
|
||||
/>
|
||||
<Card
|
||||
title="Conditional Logic"
|
||||
description="Create sophisticated decision trees using conditional branching and routing"
|
||||
icon="🔀"
|
||||
/>
|
||||
<Card
|
||||
title="API Integrations"
|
||||
description="Connect to external services with customizable API blocks and tools"
|
||||
icon="🔌"
|
||||
/>
|
||||
</Cards>
|
||||
<Features />
|
||||
|
||||
## Core Components
|
||||
|
||||
Sim Studio is built around two primary components:
|
||||
|
||||
### Blocks
|
||||
|
||||
Blocks are the fundamental building elements of your workflows. Each block serves a specific purpose:
|
||||
|
||||
<Files>
|
||||
<Folder name="Blocks" defaultOpen>
|
||||
<File name="Agent Block" annotation="Create AI agents using any LLM provider" />
|
||||
<File name="API Block" annotation="Connect to external services and APIs" />
|
||||
<File name="Condition Block" annotation="Add conditional branching to your workflows" />
|
||||
<File name="Function Block" annotation="Execute custom JavaScript/TypeScript code" />
|
||||
<File name="Evaluator Block" annotation="Assess responses against defined criteria" />
|
||||
<File name="Router Block" annotation="Direct workflow execution based on input analysis" />
|
||||
</Folder>
|
||||
</Files>
|
||||
|
||||
### Tools
|
||||
|
||||
Tools extend the capabilities of blocks by providing specialized functionality:
|
||||
|
||||
<Files>
|
||||
<Folder name="Tools" defaultOpen>
|
||||
<File name="Data Transformation" annotation="Process and transform data between blocks" />
|
||||
<File name="Configuration Management" annotation="Handle environment variables and secrets" />
|
||||
<File name="Testing Suite" annotation="Validate workflow behavior with test scenarios" />
|
||||
<File name="Logging & Monitoring" annotation="Track execution and performance metrics" />
|
||||
</Folder>
|
||||
</Files>
|
||||
##
|
||||
|
||||
Ready to get started? Check out our [Getting Started](/docs/getting-started) guide or explore our [Blocks](/docs/blocks) and [Tools](/docs/tools) in more detail.
|
||||
@@ -1,4 +1,4 @@
|
||||
{
|
||||
"title": "Sim Studio Documentation",
|
||||
"pages": ["introduction", "getting-started", "blocks", "tools"]
|
||||
"pages": ["introduction", "getting-started", "blocks", "tools", "connections", "execution"]
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user