Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
10 changes: 10 additions & 0 deletions docs/content/docs/(getting-started)/architecture.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,20 @@
---
<<<<<<< HEAD
description: "ByteChef Platform Architecture. Learn the infrastructure design and technical components of the ByteChef system in your ByteChef workflows."
title: Platform Architecture
=======
title: Platform Architecture
description: ByteChef is an open-source, enterprise-ready platform for API integration and workflow automation.
>>>>>>> origin/master
---

ByteChef is built on a scalable, modular architecture designed to handle enterprise-grade workflow automation and integrations. The platform provides a flexible foundation that supports multiple deployment models, from cloud-hosted to on-premises deployments.

<<<<<<< HEAD
![Workflow Architecture](/Architecture_Diagram.png)

=======
>>>>>>> origin/master
## System Architecture Overview

The ByteChef platform is composed of several interconnected layers that work together to deliver workflow automation capabilities.
Expand Down
6 changes: 5 additions & 1 deletion docs/content/docs/(getting-started)/glossary.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Glossary
description: Terms used in ByteChef platform.
description: "ByteChef glossary. Quick reference guide for automation terms, workflows, components, triggers, and integration concepts."
---

In this document, you will find a list of terms used in ByteChef's platform. Here are the definitions:
Expand All @@ -17,7 +17,11 @@ Workflows are a series of actions and triggers that automate processes within th

In ByteChef, a component is a modular building block that encapsulates specific functionalities within the platform. Each component is designed to interact with external services or perform particular tasks, making it an essential part of creating workflows.

<<<<<<< HEAD
Components are composed of two main elements: **Actions** and **Triggers**.
=======
Components are composed of two main elements: actions and triggers.
>>>>>>> origin/master

By combining actions and triggers, components enable users to automate complex processes and integrate various services seamlessly. Components are designed to be reusable and extendable, allowing users to customize and expand their workflows according to their needs.

Expand Down
8 changes: 6 additions & 2 deletions docs/content/docs/(getting-started)/introduction.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
---
title: Introduction
<<<<<<< HEAD
description: "This is the documentation for ByteChef, an open-source workflow automation platform that connects your entire tech stack with AI-powered intelligence."
=======
description: This is the documentation for ByteChef, an open-source workflow automation platform that connects your entire tech stack with AI-powered intelligence.
>>>>>>> origin/master
icon: Album
---

Expand All @@ -21,7 +25,7 @@ This documentation covers everything from setup to usage and development. It's a
Bring the power of ByteChef directly into your product—embed the workflow builder, run automations behind the scenes, and let your users create workflows inside your app.
</Card>

<Card icon={<Blocks />} title='Developer Guide' href='/developer-guide'>
<Card icon={<Blocks />} title='Developer Guide' href='/developer-guide/build-component/initial-setup'>
Get started with building components/connectors, writing custom functions, and extending ByteChef. Everything you need to develop, test, and deploy powerful automations.
</Card>

Expand All @@ -48,4 +52,4 @@ Check out our [roadmap](https://github.com/orgs/bytechefhq/projects/3) to get in

### Contributing

If you'd like to contribute, kindly read our [Contributing Guide](https://github.com/bytechefhq/bytechef/blob/master/CONTRIBUTING.md) to learn and understand about our development process, how to propose bug fixes and improvements, and how to build and test your changes to ByteChef.
If you'd like to contribute, kindly read our [Contributing Guide](https://github.com/bytechefhq/bytechef/blob/master/CONTRIBUTING.md) to learn and understand about our development process, how to propose bug fixes and improvements, and how to build and test your changes to ByteChef.
8 changes: 8 additions & 0 deletions docs/content/docs/(getting-started)/quickstart.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
---
title: "Quick Start"
<<<<<<< HEAD
description: "Quick Start guide for ByteChef. Learn how to build your first workflow in minutes with Spotify and Slack integration examples."
=======
description: "This guide walks you through the basics of ByteChef in a few minutes. You'll learn how to build a workflow quickly, so no much configuration needed."
>>>>>>> origin/master
---

In this tutorial, you'll learn:
Expand Down Expand Up @@ -129,7 +133,11 @@ The demo in this quickstart demonstrates the core concept of automation:

Here are a few things you can explore next:

<<<<<<< HEAD
- [Build Workflows](/automation/build)
=======
- [Build Workflows](/automation/build-workflows)
>>>>>>> origin/master
- [Browse 200+ Components](/reference/components)
- [Deploy your workflow](/automation/deploy)
- [Monitor Executions](/automation/monitor)
62 changes: 62 additions & 0 deletions docs/content/docs/(getting-started)/what-is-bytechef.mdx
Original file line number Diff line number Diff line change
@@ -1,12 +1,43 @@
---
<<<<<<< HEAD
title: What is ByteChef?
description: "ByteChef is an open-source platform for building AI agents, automating workflows, and integrating applications across SaaS, APIs, and databases."
---
=======
title: "What is ByteChef?"
description: "ByteChef is an open-source, enterprise-ready platform for building AI agents, automating workflows, and integrating applications across SaaS, APIs, and databases with flexible deployment."
---

>>>>>>> origin/master
ByteChef is an open-source platform that is designed to help you build AI agents, automate workflows, and integrate applications across your entire tech stack. Whether you're connecting SaaS tools, APIs, or databases, ByteChef provides a flexible, scalable solution for workflow automation.

## Core Capabilities

<<<<<<< HEAD
**Workflow Automation**: Build powerful automations that connect your applications and services. Create workflows that handle repetitive tasks, process data, and orchestrate complex business logic without writing code.

**AI-Powered Intelligence**: Leverage cutting-edge AI models to add intelligent decision-making, content generation, and data analysis to your automations. Build smarter workflows that learn and adapt.

**500+ Integrations**: Connect to a vast ecosystem of applications including Slack, Salesforce, HubSpot, Google Workspace, Microsoft Teams, and hundreds more. Seamlessly integrate your entire tech stack in one platform.

**Multi-Cloud Deployment**: Choose how you want to run ByteChef. Deploy to the cloud and let us handle infrastructure, or run it yourself on Docker, Kubernetes, AWS, Azure, Google Cloud, or DigitalOcean. Complete control over your data and deployment.

## Why ByteChef?

**Open Source**: Full transparency and control. Audit the code, customize it for your needs, and contribute back to the community. No vendor lock-in.

**Enterprise Ready**: Built to scale. Handle millions of workflow executions, manage complex permissions, implement advanced security, and monitor performance with built-in observability.

**Developer Friendly**: Clean APIs, comprehensive documentation, and a vibrant community. Build, test, and deploy with confidence using our developer tools and SDKs.

**Flexible & Extensible**: Create custom components to integrate with proprietary systems. Build exactly what you need without limitations.

## Use Cases

**Sales & Marketing Automation**: Capture leads from multiple sources, enrich data, qualify prospects, and nurture them through your sales pipeline. Keep data in sync across your CRM and marketing tools.

**Customer Support Automation**: Route support tickets intelligently, generate responses with AI, track issues across channels, and keep customers informed automatically.
=======
**Workflow Automation**
Build powerful automations that connect your applications and services. Create workflows that handle repetitive tasks, process data, and orchestrate complex business logic without writing code.

Expand Down Expand Up @@ -40,10 +71,18 @@ Capture leads from multiple sources, enrich data, qualify prospects, and nurture

**Customer Support Automation**
Route support tickets intelligently, generate responses with AI, track issues across channels, and keep customers informed automatically.
>>>>>>> origin/master

**Data Integration & Synchronization**
Keep databases, CRMs, data warehouses, and analytics platforms in sync. Eliminate manual data entry and ensure consistency across systems.

<<<<<<< HEAD
**Content & Publishing Workflows**: Automate content creation, approval workflows, distribution, and scheduling across multiple channels. Streamline your publishing pipeline.

**Finance & Operations**: Automate invoicing, expense tracking, financial reporting, and reconciliation. Reduce errors and free up your team for strategic work.

**HR & People Operations**: Automate onboarding, offboarding, leave management, and employee communications. Keep HR processes running smoothly.
=======
**Content & Publishing Workflows**
Automate content creation, approval workflows, distribution, and scheduling across multiple channels. Streamline your publishing pipeline.

Expand All @@ -52,6 +91,7 @@ Automate invoicing, expense tracking, financial reporting, and reconciliation. R

**HR & People Operations**
Automate onboarding, offboarding, leave management, and employee communications. Keep HR processes running smoothly.
>>>>>>> origin/master

## Key Features

Expand All @@ -69,6 +109,21 @@ Automate onboarding, offboarding, leave management, and employee communications.

Ready to automate? Choose your path:

<<<<<<< HEAD
- **[Quick Start](/quickstart)**: Build your first workflow in minutes
- **[Automation Guide](/automation)**: Learn workflow fundamentals
- **[Browse Integrations](/reference/components)**: Explore 500+ pre-built connections
- **[Developer Guide](/developer-guide)**: Create custom components and extend ByteChef
- **[Deploy](/automation/deploy)**: Move from testing to production

## How It Works

1. **Create a Project**: Organize your automations into logical groups
2. **Build Workflows**: Connect components, add logic, and configure data mapping
3. **Test & Iterate**: Run workflows immediately and see results in real-time
4. **Deploy**: Activate workflows in production with monitoring and observability
5. **Monitor & Optimize**: Track execution, debug issues, and improve performance
=======
- **[Quick Start](/quickstart)** — Build your first workflow in minutes
- **[Automation Guide](/automation)** — Learn workflow fundamentals
- **[Browse Integrations](/reference/components)** — Explore 500+ pre-built connections
Expand All @@ -82,14 +137,21 @@ Ready to automate? Choose your path:
3. **Test & Iterate** — Run workflows immediately and see results in real-time
4. **Deploy** — Activate workflows in production with monitoring and observability
5. **Monitor & Optimize** — Track execution, debug issues, and improve performance
>>>>>>> origin/master

## Community & Support

ByteChef is backed by an active community and comprehensive documentation. Get help through our forums, GitHub discussions, or detailed docs.

<<<<<<< HEAD
- **GitHub**:[github.com/bytechefhq/bytechef](https://github.com/bytechefhq/bytechef)
- **Documentation**: Comprehensive guides and API reference
- **Community**: Connect with other users and get support
=======
- **GitHub** — [github.com/bytechefhq/bytechef](https://github.com/bytechefhq/bytechef)
- **Documentation** — Comprehensive guides and API reference
- **Community** — Connect with other users and get support
>>>>>>> origin/master

---

Expand Down
6 changes: 3 additions & 3 deletions docs/content/docs/automation/build/index.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: "Overview"
description: "An introduction to building and managing projects and workflows in ByteChef."
description: "Building and managing projects and workflows in ByteChef. Organize and structure automation. Learn how to implement this in your ByteChef workflows."
title: Overview
---

In the following steps, we will learn how to build and manage projects and workflows within ByteChef. Projects and
workflows are essential components of automation, enabling you to organize tasks, streamline processes, and enhance
operational efficiency.
operational efficiency.
6 changes: 3 additions & 3 deletions docs/content/docs/automation/build/projects.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Projects"
description: "Learn how to create, manage, and organize projects within ByteChef."
description: "Learn how to create, manage, and organize projects in ByteChef. Learn how to implement this in your ByteChef workflows."
title: Build Projects
---

Every project on ByteChef consists of one or more workflows. Projects help organize and manage workflows, making it
Expand Down Expand Up @@ -79,4 +79,4 @@ easier to group related automation processes together.

<div style={{ position: 'relative', height: 0, width: '100%', overflow: 'hidden', zIndex: 99999, boxSizing: 'border-box', paddingBottom: 'calc(53.02672956% + 32px)' }}>
<iframe src="https://www.guidejar.com/embed/a8FJf631lYiJfSEDeFSn?type=1&controls=on" width="100%" height="100%" style={{ height: '100%', position: 'absolute', inset: 0 }} allowFullScreen frameBorder="0"></iframe>
</div>
</div>
6 changes: 3 additions & 3 deletions docs/content/docs/automation/build/universal-ai.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Universal AI"
description: "Learn how to work with AI Text and AI Image"
description: "Integrate AI capabilities into ByteChef workflows. Use AI for text generation and image processing. Learn how to implement this in your ByteChef workflows."
title: Universal AI
---

This is a guide no using universal AI components like **AI Text** or **AI Image**.
Expand All @@ -22,4 +22,4 @@ After that, you should be able to work with **AI Text** and **AI Image** compone

<div style={{ position: 'relative', height: 0, width: '100%', overflow: 'hidden', zIndex: 99999, boxSizing: 'border-box', paddingBottom: 'calc(53.02672956% + 32px)' }}>
<iframe src="https://www.guidejar.com/embed/3f85c053-7e73-4fd6-b48a-86371a718381?type=1&controls=on" width="100%" height="100%" style={{ height: '100%', position: 'absolute', inset: 0 }} allowFullScreen frameBorder="0"></iframe>
</div>
</div>
6 changes: 3 additions & 3 deletions docs/content/docs/automation/build/workflows.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Workflows"
description: "Learn how to create, edit, and manage workflows effectively."
description: "Learn how to create, edit, and manage workflows in ByteChef. Learn how to implement this in your ByteChef workflows."
title: Workflows
---

## Create Workflow
Expand Down Expand Up @@ -198,4 +198,4 @@ This part of code will look like this:

<div style={{ position: 'relative', height: 0, width: '100%', overflow: 'hidden', zIndex: 99999, boxSizing: 'border-box', paddingBottom: 'calc(53.02672956% + 32px)' }}>
<iframe src="https://www.guidejar.com/embed/hYc7cWhjM3WmFAzwzQLs?type=1&controls=on" width="100%" height="100%" style={{ height: '100%', position: 'absolute', inset: 0 }} allowFullScreen frameBorder="0"></iframe>
</div>
</div>
26 changes: 26 additions & 0 deletions docs/content/docs/automation/connect-data/how-to-guides/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
description: "ByteChef How-To Guides. Step-by-step tutorials and best practices for automating workflows and integrations."
title: How-To Guides
---


Follow these step-by-step guides to connect to popular services in ByteChef.

## Popular Integrations

- [Connect to Google Workspace](/automation/connect-data/how-to-guides/google-workspace)
- [Connect to Microsoft 365](/automation/connect-data/how-to-guides/microsoft-365)
- [Connect to Salesforce](/automation/connect-data/how-to-guides/salesforce)
- [Connect to Slack](/automation/connect-data/how-to-guides/slack)
- [Connect to Dropbox](/automation/connect-data/how-to-guides/dropbox)

## Authentication Methods

Learn about different authentication methods:
- [OAuth 2.0 Authentication](/automation/connect-data/how-to-guides/oauth2-authentication)
- [API Key Authentication](/automation/connect-data/how-to-guides/api-key-authentication)
- [Basic Authentication](/automation/connect-data/how-to-guides/basic-authentication)

## Troubleshooting

Having issues with connections? Check out our [troubleshooting guide](/automation/connect-data/how-to-guides/troubleshooting).
11 changes: 11 additions & 0 deletions docs/content/docs/automation/connect-data/how-to-guides/meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"title": "How-To Guides",
"description": "Step-by-step guides for connecting to third-party services",
"pages": [
"index",
"google-workspace",
"microsoft-365",
"salesforce",
"slack"
]
}
5 changes: 5 additions & 0 deletions docs/content/docs/automation/connect-data/meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@
"icon": "Link",
"pages": [
"overview",
<<<<<<< HEAD
"how-to-guides/index"
]
=======
"authentication",
"troubleshooting"]
>>>>>>> origin/master
}
31 changes: 31 additions & 0 deletions docs/content/docs/automation/connect-data/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,12 +1,42 @@
---
<<<<<<< HEAD
description: "ByteChef Connect Data Overview. Learn how to integrate and manage data sources and connectivity in workflows."
title: Overview
---

ByteChef's Connect Data feature allows you to seamlessly integrate with hundreds of third-party applications and services. This section will guide you through managing these connections to power your automations.

=======
title: "Overview"
description: "Learn how to connect and manage third-party application connections in ByteChef."
---

>>>>>>> origin/master
## What are Connections?

Connections in ByteChef are secure links between your ByteChef account and external services. They store authentication details and configuration needed to interact with these services through your workflows.

<<<<<<< HEAD
## Key Features

- **Centralized Management**: View and manage all your connections in one place
- **Reusable**: Use the same connection across multiple workflows
- **Secure**: Credentials are encrypted and stored safely
- **Easy Setup**: Step-by-step wizards for each service

## Getting Started

1. Navigate to the "Connections" tab in the left sidebar
2. Click "+ New Connection"
3. Select the service you want to connect to
4. Follow the authentication flow for that service
5. Give your connection a meaningful name and save it

## Next Steps

- [How-To Guides](/automation/connect-data/how-to-guides) - Step-by-step connection guides for popular services
- [Connections Reference](/automation/connect-data/reference/connections) - Detailed reference for all connection types and settings
=======
Think of a connection as a bridge: one end is in ByteChef, and the other is in your favorite app (like Slack, Google Drive, or Salesforce). Once this bridge is built, ByteChef can safely walk across it to send or retrieve data.

## Key Features
Expand Down Expand Up @@ -48,3 +78,4 @@ Learn more about [Authentication Methods](/automation/connect-data/authenticatio
- [Authentication](/automation/connect-data/authentication) - Learn about different authentication methods.
- [Troubleshooting](/automation/connect-data/troubleshooting) - Fix common connection errors.
- [Connections Reference](/reference/components) - Detailed reference for all supported connections.
>>>>>>> origin/master
6 changes: 3 additions & 3 deletions docs/content/docs/automation/deploy/index.mdx
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: "Overview"
description: "An introduction to deploying projects and workflows in ByteChef."
description: "An introduction to deploying projects and workflows in ByteChef. Execute automations. Learn how to implement this in your ByteChef workflows."
title: Overview
---

In the following steps, we will learn how to deploy projects and workflows within ByteChef. Deployment allows you to
activate your workflows and put your projects into action—enabling you to fully leverage the benefits of automation.

By deploying, you ensure that your automated processes are live, efficient, and ready to deliver real value.
By deploying, you ensure that your automated processes are live, efficient, and ready to deliver real value.
6 changes: 3 additions & 3 deletions docs/content/docs/automation/deploy/projects.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Projects"
description: "Learn how to deploy projects and workflows in ByteChef."
description: "Learn how to deploy projects and workflows in ByteChef. Learn how to implement this in your ByteChef workflows."
title: Deploy Projects
---

Deploying a project in ByteChef brings your automation to life. Deployment allows workflows to run
Expand Down Expand Up @@ -87,4 +87,4 @@ We put static trigger to our workflow and deployed it for purpose of showing how

<div style={{ position: 'relative', height: 0, width: '100%', overflow: 'hidden', zIndex: 99999, boxSizing: 'border-box', paddingBottom: 'calc(53.02672956% + 32px)' }}>
<iframe src="https://www.guidejar.com/embed/dfd80b36-da00-4401-938a-65ec16903ebd?type=1&controls=on" width="100%" height="100%" style={{ height: '100%', position: 'absolute', inset: 0 }} allowFullScreen frameBorder="0"></iframe>
</div>
</div>
Loading