From 8b7e40f9a826da90658d6c8b6926ef485c819099 Mon Sep 17 00:00:00 2001 From: Gabriel Luiz Freitas Almeida Date: Tue, 2 Apr 2024 21:34:02 -0300 Subject: [PATCH] Remove first-steps.mdx and update index.mdx and sidebars.js --- docs/docs/getting-started/first-steps.mdx | 77 ----------------------- docs/docs/index.mdx | 7 +-- docs/sidebars.js | 1 - 3 files changed, 2 insertions(+), 83 deletions(-) delete mode 100644 docs/docs/getting-started/first-steps.mdx diff --git a/docs/docs/getting-started/first-steps.mdx b/docs/docs/getting-started/first-steps.mdx deleted file mode 100644 index a348b6e13..000000000 --- a/docs/docs/getting-started/first-steps.mdx +++ /dev/null @@ -1,77 +0,0 @@ -import ZoomableImage from "/src/theme/ZoomableImage.js"; - -# 🚀 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 -pipx install langflow --python python3.10 --fetch-missing-python -# or -pip install langflow -U -``` - -Or you can install a pre-release version using: - -```bash -pipx install langflow --python python3.10 --fetch-missing-python --pip-args="--pre" -# or -pip install langflow --pre -U -``` - -##⛓️ 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/Logspace/Langflow?duplicate=true). - -Remember to use a Chromium-based browser for the best experience. You'll be presented with the following screen: - - - -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 -``` - -Or you can visit the [Langflow CLI documentation](./cli) for more information. \ No newline at end of file diff --git a/docs/docs/index.mdx b/docs/docs/index.mdx index a1bbeb0ed..c2c15ec32 100644 --- a/docs/docs/index.mdx +++ b/docs/docs/index.mdx @@ -67,6 +67,7 @@ Remember to use a Chromium-based browser for the best experience. You'll be pres style={{ width: "100%" }} /> + 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. @@ -90,8 +91,4 @@ Find more information about the available options by running: ```bash langflow --help -``` - -Or you can visit the [Langflow CLI documentation](./getting-started/cli) for more information. - - +``` \ No newline at end of file diff --git a/docs/sidebars.js b/docs/sidebars.js index b0e066415..85e281c04 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -6,7 +6,6 @@ module.exports = { collapsed: false, items: [ "index", - "getting-started/first-steps", "getting-started/cli", "getting-started/hugging-face-spaces", "getting-started/creating-flows",