From fcacd865789a00b5be4f2fb1a786bb8daa212137 Mon Sep 17 00:00:00 2001
From: Mendon Kissling <59585235+mendonk@users.noreply.github.com>
Date: Wed, 1 May 2024 13:15:48 -0400
Subject: [PATCH] rodrigos-feedback
---
.../docs/getting-started/install-langflow.mdx | 28 +++-----
docs/docs/getting-started/quickstart.mdx | 64 ++++---------------
docs/docs/index.mdx | 6 +-
3 files changed, 25 insertions(+), 73 deletions(-)
diff --git a/docs/docs/getting-started/install-langflow.mdx b/docs/docs/getting-started/install-langflow.mdx
index 4571e2f98..7a567d597 100644
--- a/docs/docs/getting-started/install-langflow.mdx
+++ b/docs/docs/getting-started/install-langflow.mdx
@@ -6,27 +6,19 @@ import Admonition from "@theme/Admonition";
# 📦 Install Langflow
- Langflow v1.0 is also available in a [HuggingFace Preview Space](https://huggingface.co/spaces/Langflow/Langflow-Preview?duplicate=true) if you'd rather try it out before installing locally.
+
+ Langflow v1.0 alpha is also available in [HuggingFace Spaces](https://huggingface.co/spaces/Langflow/Langflow-Preview?duplicate=true). Try it out or follow the instructions [here](./huggingface-spaces) to install it locally.
+
-## Prerequisites
+Langflow requires [Python 3.10](https://www.python.org/downloads/release/python-3100/) and [pip](https://pypi.org/project/pip/) or [pipx](https://pipx.pypa.io/stable/installation/) to be installed on your system.
-Langflow requires the following programs installed on your system.
-
-* [Python 3.10](https://www.python.org/downloads/release/python-3100/)
-
-* [pip](https://pypi.org/project/pip/) or [pipx](https://pipx.pypa.io/stable/installation/)
-
-## Install Langflow
-
-To install Langflow:
-
-pip:
+Install Langflow with pip:
```bash
python -m pip install langflow -U
```
-pipx:
+Install Langflow with pipx:
```bash
pipx install langflow --python python3.10 --fetch-missing-python
```
@@ -35,8 +27,6 @@ Pipx can fetch the missing Python version for you with `--fetch-missing-python`,
## Install Langflow pre-release
-Use `--force-reinstall` to ensure you have the latest version of Langflow and its dependencies.
-
To install a pre-release version of Langflow:
pip:
@@ -49,9 +39,11 @@ pipx:
pipx install langflow --python python3.10 --fetch-missing-python --pip-args="--pre --force-reinstall"
```
+Use `--force-reinstall` to ensure you have the latest version of Langflow and its dependencies.
+
## Having a problem?
-If you encounter a problem, see [Possible Installation Issues](/migration/possible-installation-issues).
+If you encounter a problem, see [Common Installation Issues](/migration/possible-installation-issues).
To get help in the Langflow CLI:
@@ -66,7 +58,7 @@ python -m langflow --help
python -m langflow run
```
-2. Confirm that a local Langflow instance starts by visiting `http://127.0.0.1:7860` in your browser.
+2. Confirm that a local Langflow instance starts by visiting `http://127.0.0.1:7860` in a Chromium-based browser.
```bash
│ Welcome to ⛓ Langflow │
│ │
diff --git a/docs/docs/getting-started/quickstart.mdx b/docs/docs/getting-started/quickstart.mdx
index 33de2e0d7..f54a07747 100644
--- a/docs/docs/getting-started/quickstart.mdx
+++ b/docs/docs/getting-started/quickstart.mdx
@@ -6,64 +6,21 @@ import Admonition from "@theme/Admonition";
# ⚡️ Quickstart
-This quickstart demonstrates how to install Langflow, run it locally, build a basic prompt flow, and modify that prompt for different outcomes.
+This guide demonstrates how to build a basic prompt flow and modify that prompt for different outcomes.
## Prerequisites
-* [Python 3.10](https://www.python.org/downloads/release/python-3100/)
-
-* [pip](https://pypi.org/project/pip/) or [pipx](https://pipx.pypa.io/stable/installation/)
+* [Langflow installed](./install-langflow.mdx)
* [OpenAI API key](https://platform.openai.com)
-## Install Langflow
-
- Langflow v1.0 is also available in a [HuggingFace Preview Space](https://huggingface.co/spaces/Langflow/Langflow-Preview?duplicate=true) if you'd rather try it out before installing locally. This quickstart will run there, too.
+ Langflow v1.0 alpha is also available in [HuggingFace Spaces](https://huggingface.co/spaces/Langflow/Langflow-Preview?duplicate=true). Try it out or follow the instructions [here](./huggingface-spaces) to install it locally.
-1. To install Langflow, enter the following command in pip or pipx:
+## Hello World - Basic Prompting
-pip:
-```bash
-python -m pip install langflow -U
-```
-
-pipx:
-```bash
-pipx install langflow --python python3.10 --fetch-missing-python
-```
-Pipx can fetch the missing Python version for you with `--fetch-missing-python`, but you can also install the Python version manually.
-
-2. Start a local Langflow instance with the Langflow CLI:
-```bash
-langflow run
-```
-
-Or start Langflow with Python:
-```bash
-python -m langflow run
-```
-
-Result:
-```
-│ Welcome to ⛓ Langflow │
-│ │
-│ Access http://127.0.0.1:7860 │
-│ Collaborate, and contribute at our GitHub Repo 🚀 │
-```
-
-3. Go to `http://127.0.0.1:7860` and confirm the Langflow UI is available.
-
-
- If you encounter a problem, see [Possible Installation Issues](/migration/possible-installation-issues).
-
-
-## Create the basic prompting project
-
-Now that you have Langflow installed and running, let us formally welcome you to Langflow!👋
-
-You will use Langflow's prompt tools to issue prompts to the OpenAI LLM.
+Let's start with a Prompt component to instruct an OpenAI Model.
Prompts serve as the inputs to a large language model (LLM), acting as the interface between human instructions and computational tasks.
@@ -82,7 +39,7 @@ By submitting natural language requests in a prompt to an LLM, you can obtain an
style={{ width: "80%", margin: "20px auto" }}
/>
-This flow allows you to chat with the **OpenAI** component via a **Prompt** component.
+This flow allows you to chat with the **OpenAI** component via a **Prompt**.
Examine the **Prompt** component. The **Template** field instructs the LLM to `Answer the user as if you were a pirate.`
This should be interesting...
@@ -94,9 +51,10 @@ This should be interesting...
## Run the basic prompting flow
1. Click the **Run** button.
-The **Interaction Panel** opens, where you can converse with your bot.
+The **Interaction Panel** opens, where you can chat with your bot.
2. Type a message and press Enter.
-The bot responds in a markedly piratical manner!
+And... Ahoy! 🏴☠️
+The bot responds in a piratical manner!
## Modify the prompt for a different result
@@ -110,7 +68,9 @@ The response will be markedly different.
Well done! You've built your first prompt in Langflow. 🎉
-By adding Langflow components to this prompt, you can build all sorts of interesting flows.
+By adding Langflow components to your flow, you can create all sorts of interesting behaviors.
+
+Here are a couple of examples:
* [Memory chatbot](/starter-projects/memory-chatbot.mdx)
* [Blog writer](/starter-projects/blog-writer.mdx)
diff --git a/docs/docs/index.mdx b/docs/docs/index.mdx
index 8652999e9..a2e0d1a43 100644
--- a/docs/docs/index.mdx
+++ b/docs/docs/index.mdx
@@ -5,9 +5,9 @@ import Admonition from "@theme/Admonition";
# 👋 Welcome to Langflow
-Langflow is a low-code platform that allows you to integrate AI into everything you do.
+Langflow is a new, visual way to build, iterate, and deploy AI applications.
-Use Langflow's simple but powerful UI to build any AI application you can dream up, from simple to complex.
+Its intuitive interface allows for easy manipulation of AI building blocks, enabling developers to quickly prototype and turn their ideas into powerful, real-world solutions.
{" "}
@@ -24,7 +24,7 @@ Use Langflow's simple but powerful UI to build any AI application you can dream
* [Install Langflow](/getting-started/install-langflow) - Install and start a local Langflow server.
-* [Quickstart](/getting-started/quickstart) - Install Langflow, create a flow, and run it.
+* [Quickstart](/getting-started/quickstart) - Create a flow and run it.
* [HuggingFace Spaces](/getting-started/huggingface-spaces) - Duplicate the Langflow preview space and try it out before you install.