From 1d31ce66f5500e4b278f6627c6b724b196c93e48 Mon Sep 17 00:00:00 2001 From: Faruk AYDIN Date: Thu, 3 Feb 2022 17:47:25 +0300 Subject: [PATCH] docs: Create initial version of introduction page --- packages/docs/docs/introduction.md | 46 ++++++++++++++++++++++++++++++ packages/docs/docs/overview.md | 36 ----------------------- packages/docs/docusaurus.config.js | 2 +- 3 files changed, 47 insertions(+), 37 deletions(-) create mode 100644 packages/docs/docs/introduction.md delete mode 100644 packages/docs/docs/overview.md diff --git a/packages/docs/docs/introduction.md b/packages/docs/docs/introduction.md new file mode 100644 index 00000000..3cc5550c --- /dev/null +++ b/packages/docs/docs/introduction.md @@ -0,0 +1,46 @@ +--- +sidebar_position: 1 +slug: / +--- + +# Introduction + +:::info + +Automatisch is still in development mode. We try our best not to introduce breaking changes, but be cautious until v1 is released. + +::: + +🧐 Automatisch is a **business automation** tool. You can connect different services like Twitter, Github, Typeform, and **[more](/integrations/available-apps)** to automate your business. + +💸 You don't need to invest time or money to automate your workflows. Programming knowledge is also **not needed** to use Automatisch. + +💥 Ready for more? Use advanced features like multi-step flows, filters, formatters, and webhook support. + + + +## How it works? + +Automatisch is a software that connects the services you use to automate workflows without building integration or hiring someone to do it for you. + +For example, you can create a workflow by specifying when I have a new follower on Twitter, add this follower to the google sheet document I have created. Using this workflow, you will get a new row on the google sheet document whenever you have a new follower. This example includes only Twitter and Google Sheets as services, but it's not limited to those. You can check the list of integrations [here](/integrations/available-apps). + +You need to prepare the workflow once, and it will run continuously until you stop it or the connected account gets unlinked. Depending on the service and trigger you use, the workflow runs at intervals of 15 minutes or instantly. + +## Advantages + +There are existing solutions in the market like Zapier and Integromat. Having those, you might be asking, "Why should I use Automatisch?". + +✅ The most significant advantage of having Automatisch is **keeping your data in your own servers**. + +🤓 You can contribute and have an impact on how Automatisch is being developed since it's an **open-source software**. + +💙 **No vendor lock-in**. Suppose you don't think Automatisch is helpful to your business. In that case, you can switch to any other provider, which will be easier than switching from one cloud provider to another since you have all data and flexibility. + +## Let's start! + +Visit our [installation guide](/getting-started/installation) to setup Automatisch. It's recommended to read through all the getting started sections in the sidebar and [create your first flow](/getting-started/create-flow). + +## Something missing? + +If you find issues with the documentation or have suggestions on how to improve the documentation or the project in general, please [file an issue](https://github.com/automatisch/automatisch) for us, or send a tweet mentioning the [@automatischio](https://twitter.com/automatischio) Twitter account. diff --git a/packages/docs/docs/overview.md b/packages/docs/docs/overview.md deleted file mode 100644 index 50dedf53..00000000 --- a/packages/docs/docs/overview.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -sidebar_position: 1 -slug: / ---- - -# Overview - -Let's discover **Docusaurus in less than 5 minutes**. - -## Getting Started - -Get started by **creating a new site**. - -Or **try Docusaurus immediately** with **[docusaurus.new](https://docusaurus.new)**. - -## Generate a new site - -Generate a new Docusaurus site using the **classic template**: - -```shell -npm init docusaurus@latest my-website classic -``` - -## Start your site - -Run the development server: - -```shell -cd my-website - -npx docusaurus start -``` - -Your site starts at `http://localhost:3000`. - -Open `docs/intro.md` and edit some lines: the site **reloads automatically** and displays your changes. diff --git a/packages/docs/docusaurus.config.js b/packages/docs/docusaurus.config.js index 5f71f37a..63827158 100644 --- a/packages/docs/docusaurus.config.js +++ b/packages/docs/docusaurus.config.js @@ -48,7 +48,7 @@ const config = { items: [ { type: 'doc', - docId: 'overview', + docId: 'introduction', position: 'left', label: 'Docs', },