diff --git a/docs/docs/administration/api.mdx b/docs/docs/administration/api.mdx index 115cdc666..172a06328 100644 --- a/docs/docs/administration/api.mdx +++ b/docs/docs/administration/api.mdx @@ -14,9 +14,9 @@ The default values are `langflow` and `langflow`, respectively. -## Generating an API Key +## Generate an API Key -### Through Langflow UI +### With Langflow UI -## Configuring Environment Variables in your .env file +## Configure Environment Variables in your .env file Setting `LANGFLOW_STORE_ENVIRONMENT_VARIABLES` to `true` in your `.env` file (default) adds all variables in `LANGFLOW_VARIABLES_TO_GET_FROM_ENVIRONMENT` to your user's Global Variables. diff --git a/docs/docs/deployment/docker.md b/docs/docs/deployment/docker.md index 1ebb5746e..a8864db55 100644 --- a/docs/docs/deployment/docker.md +++ b/docs/docs/deployment/docker.md @@ -7,7 +7,7 @@ This guide will help you get LangFlow up and running using Docker and Docker Com - Docker - Docker Compose -## Steps +## Clone repo and build Docker container 1. Clone the LangFlow repository: @@ -29,11 +29,11 @@ This guide will help you get LangFlow up and running using Docker and Docker Com LangFlow will now be accessible at [http://localhost:7860/](http://localhost:7860/). -## Docker Compose Configuration +## Docker Compose configuration The Docker Compose configuration spins up two services: `langflow` and `postgres`. -### LangFlow Service +### LangFlow service The `langflow` service uses the `langflowai/langflow:latest` Docker image and exposes port 7860. It depends on the `postgres` service. @@ -46,7 +46,7 @@ Volumes: - `langflow-data`: This volume is mapped to `/var/lib/langflow` in the container. -### PostgreSQL Service +### PostgreSQL service The `postgres` service uses the `postgres:16` Docker image and exposes port 5432. @@ -60,6 +60,6 @@ Volumes: - `langflow-postgres`: This volume is mapped to `/var/lib/postgresql/data` in the container. -## Switching to a Specific LangFlow Version +## Switch to a specific LangFlow version If you want to use a specific version of LangFlow, you can modify the `image` field under the `langflow` service in the Docker Compose file. For example, to use version 1.0-alpha, change `langflowai/langflow:latest` to `langflowai/langflow:1.0-alpha`. diff --git a/docs/docs/tutorials/chatprompttemplate_guide.mdx b/docs/docs/tutorials/chatprompttemplate_guide.mdx index 48059b134..a01fec1ca 100644 --- a/docs/docs/tutorials/chatprompttemplate_guide.mdx +++ b/docs/docs/tutorials/chatprompttemplate_guide.mdx @@ -3,7 +3,7 @@ import useBaseUrl from "@docusaurus/useBaseUrl"; import ZoomableImage from "/src/theme/ZoomableImage.js"; import ReactPlayer from "react-player"; -# Building Chatbots with System Message +# Build Chatbots with the System Message Component ## Overview diff --git a/docs/docs/tutorials/custom_components.mdx b/docs/docs/tutorials/custom_components.mdx index bf9299a63..110e5dbc7 100644 --- a/docs/docs/tutorials/custom_components.mdx +++ b/docs/docs/tutorials/custom_components.mdx @@ -355,7 +355,7 @@ All done! This is what our script and brand-new custom component look like: --- -## Loading Custom Components +## Load Custom Components For advanced customization, Langflow offers the option to create and load custom components outside of the standard interface. This process involves creating the desired components using a text editor and loading them using the Langflow CLI. @@ -380,7 +380,7 @@ Your structure should look something like this: └── ... ``` -### Loading Custom Components +### Load Custom Components The recommended way to load custom components is to set the _`LANGFLOW_COMPONENTS_PATH`_ environment variable to the path of your custom components directory. Then, run the Langflow CLI as usual. @@ -397,7 +397,7 @@ langflow run --components-path /path/to/components Langflow will attempt to load all of the components found in the specified directory. If a component fails to load due to errors in the component's code, Langflow will print an error message to the console but will continue loading the rest of the components. -### Interacting with Custom Components +### Interact with Custom Components Once your custom components have been loaded successfully, they will appear in Langflow's sidebar. From there, you can add them to your Langflow canvas for use. However, please note that components with errors will not be available for addition to the canvas. Always ensure your code is error-free before attempting to load components. diff --git a/docs/docs/tutorials/loading_document.mdx b/docs/docs/tutorials/loading_document.mdx index 4a6143a0e..c123624c1 100644 --- a/docs/docs/tutorials/loading_document.mdx +++ b/docs/docs/tutorials/loading_document.mdx @@ -3,7 +3,7 @@ import useBaseUrl from "@docusaurus/useBaseUrl"; import ZoomableImage from "/src/theme/ZoomableImage.js"; import ReactPlayer from "react-player"; -# Integrating Documents with Prompt Variables +# Integrate Documents with Prompt Variables ## Overview