Skip to content

Commit 6df69f0

Browse files
committed
docs: update documentation files
1 parent 8117fcf commit 6df69f0

30 files changed

Lines changed: 268 additions & 330 deletions

docs/content/docs/(getting-started)/architecture.mdx

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,11 @@
11
---
2-
<<<<<<< HEAD
3-
description: "ByteChef Platform Architecture. Learn the infrastructure design and technical components of the ByteChef system in your ByteChef workflows."
4-
title: Platform Architecture
5-
=======
62
title: Platform Architecture
7-
description: ByteChef is an open-source, enterprise-ready platform for API integration and workflow automation.
8-
>>>>>>> origin/master
3+
description: "ByteChef Platform Architecture. Learn the infrastructure design and technical components of the ByteChef system in your ByteChef workflows."
94
---
105

116
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.
127

13-
<<<<<<< HEAD
148
![Workflow Architecture](/Architecture_Diagram.png)
15-
16-
=======
17-
>>>>>>> origin/master
189
## System Architecture Overview
1910

2011
The ByteChef platform is composed of several interconnected layers that work together to deliver workflow automation capabilities.

docs/content/docs/(getting-started)/glossary.mdx

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,7 @@ Workflows are a series of actions and triggers that automate processes within th
1717

1818
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.
1919

20-
<<<<<<< HEAD
2120
Components are composed of two main elements: **Actions** and **Triggers**.
22-
=======
23-
Components are composed of two main elements: actions and triggers.
24-
>>>>>>> origin/master
2521

2622
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.
2723

docs/content/docs/(getting-started)/introduction.mdx

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,6 @@
11
---
22
title: Introduction
3-
<<<<<<< HEAD
43
description: "This is the documentation for ByteChef, an open-source workflow automation platform that connects your entire tech stack with AI-powered intelligence."
5-
=======
6-
description: This is the documentation for ByteChef, an open-source workflow automation platform that connects your entire tech stack with AI-powered intelligence.
7-
>>>>>>> origin/master
84
icon: Album
95
---
106

docs/content/docs/(getting-started)/quickstart.mdx

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,6 @@
11
---
22
title: "Quick Start"
3-
<<<<<<< HEAD
43
description: "Quick Start guide for ByteChef. Learn how to build your first workflow in minutes with Spotify and Slack integration examples."
5-
=======
6-
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."
7-
>>>>>>> origin/master
84
---
95

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

134130
Here are a few things you can explore next:
135131

136-
<<<<<<< HEAD
137-
- [Build Workflows](/automation/build)
138-
=======
139132
- [Build Workflows](/automation/build-workflows)
140-
>>>>>>> origin/master
141133
- [Browse 200+ Components](/reference/components)
142134
- [Deploy your workflow](/automation/deploy)
143135
- [Monitor Executions](/automation/monitor)

docs/content/docs/(getting-started)/what-is-bytechef.mdx

Lines changed: 0 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,11 @@
11
---
2-
<<<<<<< HEAD
3-
title: What is ByteChef?
4-
description: "ByteChef is an open-source platform for building AI agents, automating workflows, and integrating applications across SaaS, APIs, and databases."
5-
---
6-
=======
72
title: "What is ByteChef?"
83
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."
94
---
10-
11-
>>>>>>> origin/master
125
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.
136

147
## Core Capabilities
158

16-
<<<<<<< HEAD
17-
**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.
18-
19-
**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.
20-
21-
**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.
22-
23-
**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.
24-
25-
## Why ByteChef?
26-
27-
**Open Source**: Full transparency and control. Audit the code, customize it for your needs, and contribute back to the community. No vendor lock-in.
28-
29-
**Enterprise Ready**: Built to scale. Handle millions of workflow executions, manage complex permissions, implement advanced security, and monitor performance with built-in observability.
30-
31-
**Developer Friendly**: Clean APIs, comprehensive documentation, and a vibrant community. Build, test, and deploy with confidence using our developer tools and SDKs.
32-
33-
**Flexible & Extensible**: Create custom components to integrate with proprietary systems. Build exactly what you need without limitations.
34-
35-
## Use Cases
36-
37-
**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.
38-
39-
**Customer Support Automation**: Route support tickets intelligently, generate responses with AI, track issues across channels, and keep customers informed automatically.
40-
=======
419
**Workflow Automation**
4210
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.
4311

@@ -71,18 +39,10 @@ Capture leads from multiple sources, enrich data, qualify prospects, and nurture
7139

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

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

79-
<<<<<<< HEAD
80-
**Content & Publishing Workflows**: Automate content creation, approval workflows, distribution, and scheduling across multiple channels. Streamline your publishing pipeline.
81-
82-
**Finance & Operations**: Automate invoicing, expense tracking, financial reporting, and reconciliation. Reduce errors and free up your team for strategic work.
83-
84-
**HR & People Operations**: Automate onboarding, offboarding, leave management, and employee communications. Keep HR processes running smoothly.
85-
=======
8646
**Content & Publishing Workflows**
8747
Automate content creation, approval workflows, distribution, and scheduling across multiple channels. Streamline your publishing pipeline.
8848

@@ -91,7 +51,6 @@ Automate invoicing, expense tracking, financial reporting, and reconciliation. R
9151

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

9655
## Key Features
9756

@@ -109,21 +68,6 @@ Automate onboarding, offboarding, leave management, and employee communications.
10968

11069
Ready to automate? Choose your path:
11170

112-
<<<<<<< HEAD
113-
- **[Quick Start](/quickstart)**: Build your first workflow in minutes
114-
- **[Automation Guide](/automation)**: Learn workflow fundamentals
115-
- **[Browse Integrations](/reference/components)**: Explore 500+ pre-built connections
116-
- **[Developer Guide](/developer-guide)**: Create custom components and extend ByteChef
117-
- **[Deploy](/automation/deploy)**: Move from testing to production
118-
119-
## How It Works
120-
121-
1. **Create a Project**: Organize your automations into logical groups
122-
2. **Build Workflows**: Connect components, add logic, and configure data mapping
123-
3. **Test & Iterate**: Run workflows immediately and see results in real-time
124-
4. **Deploy**: Activate workflows in production with monitoring and observability
125-
5. **Monitor & Optimize**: Track execution, debug issues, and improve performance
126-
=======
12771
- **[Quick Start](/quickstart)** — Build your first workflow in minutes
12872
- **[Automation Guide](/automation)** — Learn workflow fundamentals
12973
- **[Browse Integrations](/reference/components)** — Explore 500+ pre-built connections
@@ -137,21 +81,14 @@ Ready to automate? Choose your path:
13781
3. **Test & Iterate** — Run workflows immediately and see results in real-time
13882
4. **Deploy** — Activate workflows in production with monitoring and observability
13983
5. **Monitor & Optimize** — Track execution, debug issues, and improve performance
140-
>>>>>>> origin/master
14184

14285
## Community & Support
14386

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

146-
<<<<<<< HEAD
147-
- **GitHub**:[github.com/bytechefhq/bytechef](https://github.com/bytechefhq/bytechef)
148-
- **Documentation**: Comprehensive guides and API reference
149-
- **Community**: Connect with other users and get support
150-
=======
15189
- **GitHub**[github.com/bytechefhq/bytechef](https://github.com/bytechefhq/bytechef)
15290
- **Documentation** — Comprehensive guides and API reference
15391
- **Community** — Connect with other users and get support
154-
>>>>>>> origin/master
15592

15693
---
15794

docs/content/docs/automation/build/index.mdx

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,14 @@ description: "Building and managing projects and workflows in ByteChef. Organize
33
title: Overview
44
---
55

6-
In the following steps, we will learn how to build and manage projects and workflows within ByteChef. Projects and
7-
workflows are essential components of automation, enabling you to organize tasks, streamline processes, and enhance
8-
operational efficiency.
6+
Learn how to build and manage your automation within ByteChef. Projects and workflows are important components of automation, enabling you to organize tasks, streamline processes, and enhance
7+
operational efficiency.
8+
9+
In this section, you will learn everything you need to organize your work and create automated workflows.
10+
11+
## What's Covered
12+
- **[Projects](/automation/build/projects)**: Organize your automation by creating and managing projects. In this guide, you'll learn how to create, edit, duplicate, publish, and delete projects. Apart from that, the guide also includes steps on how to create and import workflows.
13+
- **[Workflows](/automation/build/worklfows)**: Build the automation sequences that do the work. Set up triggers, configure actions, and control how your workflows run.
14+
- **[Universal AI](/automation/build/universal-ai)** - Add AI capabilities to your workflows using AI cimponennts like **AI Text** or **AI Image** for tasks like text generation and image processing.
15+
16+
If you want to understand the necessary terminologies for ByteChef, you can check out the [Glossary](/glossary) for definitions of key concepts.

docs/content/docs/automation/connect-data/authentication/api-key.mdx

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,6 @@
22
title: "API Key Authentication"
33
description: "Learn how to use API Keys to connect to third-party services in ByteChef"
44
---
5-
6-
# API Key Authentication
7-
85
API Key authentication is a simple way to authenticate with many third-party services. An API key is a unique identifier used to authenticate a user, developer, or calling program to an API.
96

107
## How it Works

docs/content/docs/automation/connect-data/authentication/basic.mdx

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,6 @@
22
title: "Basic Authentication"
33
description: "Learn how to use Basic Authentication to connect to third-party services in ByteChef"
44
---
5-
6-
# Basic Authentication
7-
85
Basic Authentication is a simple authentication scheme built into the HTTP protocol. It uses a username and a password to authenticate requests.
96

107
## How it Works

docs/content/docs/automation/connect-data/authentication/bearer.mdx

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,6 @@
22
title: "Bearer Authentication"
33
description: "Learn how to use Bearer Tokens to connect to third-party services in ByteChef"
44
---
5-
6-
# Bearer Authentication
7-
85
Bearer Authentication (also called token authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens. The name "Bearer authentication" can be understood as "give access to the bearer of this token."
96

107
## How it Works

docs/content/docs/automation/connect-data/authentication/oauth2.mdx

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,6 @@
22
title: "OAuth 2.0 Authentication"
33
description: "Learn how to use OAuth 2.0 to connect to third-party services in ByteChef"
44
---
5-
6-
# OAuth 2.0 Authentication
7-
85
OAuth 2.0 is the industry-standard protocol for authorization. It allows ByteChef to obtain limited access to user accounts on an HTTP service, such as Google, GitHub, or Salesforce, without requiring your password.
96

107
## How it Works

0 commit comments

Comments
 (0)