From ed37228396e9fa2bb7fa99bfa7c07ef338639541 Mon Sep 17 00:00:00 2001
From: Gabriel Luiz Freitas Almeida <gabriel@logspace.ai>
Date: Fri, 5 Apr 2024 12:15:37 -0300
Subject: [PATCH] Update Langflow documentation (#1618)

---
 docs/docs/index.mdx | 96 +++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 92 insertions(+), 4 deletions(-)

diff --git a/docs/docs/index.mdx b/docs/docs/index.mdx
index 840f10f10..377517353 100644
--- a/docs/docs/index.mdx
+++ b/docs/docs/index.mdx
@@ -1,10 +1,13 @@
-# 👋 Welcome to Langflow
-
-Langflow is an easy way to create flows. The drag-and-drop feature allows quick and effortless experimentation, while the built-in chat interface facilitates real-time interaction. It provides options to edit prompt parameters, create chains and agents, track thought processes, and export flows.
-
 import ThemedImage from "@theme/ThemedImage";
 import useBaseUrl from "@docusaurus/useBaseUrl";
 import ZoomableImage from "/src/theme/ZoomableImage.js";
+import Admonition from "@theme/Admonition";
+
+# 👋 Welcome to Langflow
+
+Langflow is an easy way to build from simple to complex AI applications. It is a low-code platform that allows you to integrate AI into everything you do.
+
+{" "}
 
 {" "}
 
@@ -16,3 +19,88 @@ import ZoomableImage from "/src/theme/ZoomableImage.js";
   }}
   style={{ width: "100%" }}
 />
+
+## 🚀 First steps
+
+## Installation
+
+Make sure you have **Python 3.10** installed on your system.
+
+You can install **Langflow** with [pipx](https://pipx.pypa.io/stable/installation/) or with pip.
+
+Pipx can fetch the missing Python version for you, but you can also install it manually.
+
+```bash
+pip install langflow -U
+# or (since pipx 1.5.0)
+pipx install langflow --python python3.10 --fetch-missing-python
+```
+
+Or you can install a pre-release version using:
+
+```bash
+pip install langflow --pre --force-reinstall
+# or (since pipx 1.5.0)
+pipx install langflow --python python3.10 --fetch-missing-python --pip-args="--pre --force-reinstall"
+```
+
+We recommend using --force-reinstall to ensure you have the latest version of Langflow and its dependencies.
+
+### ⛓️ Running Langflow
+
+Langflow can be run in a variety of ways, including using the command-line interface (CLI) or HuggingFace Spaces.
+
+```bash
+langflow run # or langflow --help
+```
+
+#### 🤗 HuggingFace Spaces
+
+Hugging Face provides a great alternative for running Langflow in their Spaces environment. This means you can run Langflow without any local installation required.
+
+The first step is to go to the [Langflow Space](https://huggingface.co/spaces/Langflow/Langflow?duplicate=true) or [Langflow 1.0 Preview Space](https://huggingface.co/spaces/Langflow/Langflow-Preview?duplicate=true)
+
+Remember to use a Chromium-based browser for the best experience. You'll be presented with the following screen:
+
+<ZoomableImage
+  alt="Docusaurus themed image"
+  sources={{
+    light: "img/duplicate-space.png",
+    dark: "img/duplicate-space.png",
+  }}
+  style={{ width: "100%", margin: "20px auto" }}
+/>
+
+From here, just name your Space, define the visibility (Public or Private), and click on `Duplicate Space` to start the installation process. When that is done, you'll be redirected to the Space's main page to start using Langflow right away!
+
+Once you get Langflow running, click on New Project in the top right corner of the screen. Langflow provides a range of example flows to help you get started.
+
+To quickly try one of them, open a starter example, set up your API keys and click ⚡ Run, on the bottom right corner of the canvas. This will open up Langflow's Interaction Panel with the chat console, text inputs, and outputs.
+
+### 🖥️ Command Line Interface (CLI)
+
+Langflow provides a command-line interface (CLI) for easy management and configuration.
+
+#### Usage
+
+You can run the Langflow using the following command:
+
+```bash
+langflow run [OPTIONS]
+```
+
+Find more information about the available options by running:
+
+```bash
+langflow --help
+```
+
+## Find out more about 1.0
+
+<Admonition type="caution" icon="🚧" title="ZONE UNDER CONSTRUCTION">
+  <p>
+    We are currently working on updating the documentation for Langflow 1.0.
+  </p>
+</Admonition>
+
+To get you learning more about what's new and why you should be excited about Langflow 1.0, go to [A new chapter for Langflow](https://pre-release.langflow.org/whats-new/a-new-chapter-langflow) and also come back often to check out our [migration guides](https://pre-release.langflow.org/whats-new/migrating-to-one-point-zero) as we release them.