diff --git a/docs/docs/administration/collections-projects.mdx b/docs/docs/administration/collections-projects.mdx new file mode 100644 index 000000000..ccb57a61a --- /dev/null +++ b/docs/docs/administration/collections-projects.mdx @@ -0,0 +1,93 @@ +import ThemedImage from "@theme/ThemedImage"; +import useBaseUrl from "@docusaurus/useBaseUrl"; +import ZoomableImage from "/src/theme/ZoomableImage.js"; +import ReactPlayer from "react-player"; +import Admonition from "@theme/Admonition"; + +# Collections and Projects + +My Collection is a space in Langflow where users can manage, organize, and access their flows and components. +Flows and components are displayed as individual cards that provide relevant information. + + + +* **Folders**: Users can organize their projects into folders. Default folders include "My Projects" and the ability to create new folders. Hover over a folder to access options to download or delete it. + +* **Search Bar** Enables users to quickly search through their flows and components. + +* **Select All**: This feature allows users to select all projects displayed on the page for batch actions like moving, deleting, or exporting. + +Click on a flow card to open it in Langflow Workspace or use the **Playground Button** for direct access to execute and interact with the flow’s chatbot interface. + +## Collections + +Components created or imported by the user are also displayed in **My Collection** and can be directly removed from here. + +A collection is a snapshot of flows available in a database. + +Collections can be downloaded to local storage and uploaded for future use. + +
+ +
+ +## Project + +A **Project** can be a flow or a component. To view your saved projects, select **My Collection**. + +Your **Projects** are displayed. + +Click the **![Playground icon](/logos/botmessage.svg) Playground** button to run a flow from the **My Collection** screen. + +In the top left corner of the screen are options for **Download Collection**, **Upload Collection**, and **New Project**. + +Select **Download Collection** to save your project to your local machine. This downloads all flows and components as a `.json` file. + +Select **Upload Collection** to upload a flow or component `.json` file from your local machine. + +Select **New Project** to create a new project. In addition to a blank workspace, [starter projects](../starter-projects/basic-prompting) are also available. + +## Project options menu + +To see options for your project, in the upper left corner of the workspace, select the dropdown menu. + + + +* **New** - Start a new project. + +* **Duplicate** - Duplicate the current flow as a new project. + +* **Settings** - Modify the project's **Name** or **Description**. + +* **Import** - Upload a flow `.json` file from your local machine. + +* **Export** - Download your current project to your local machine as a `.json` file. + +* **Undo** or **Redo** - Undo or redo your last action. + +## Project folders + +As of Langflow 1.0 alpha, more options are available for storing projects with **folders**. + +Create new folders with the **New folder** button. One folder can store multiple projects (as the default My Projects folder does). + +You can download folders of projects as a single JSON file, and upload files and flows to your folder. + +Click the **Trash** icon to delete a folder. + diff --git a/docs/docs/getting-started/workspace.mdx b/docs/docs/getting-started/workspace.mdx index 5a5bd5827..eef951494 100644 --- a/docs/docs/getting-started/workspace.mdx +++ b/docs/docs/getting-started/workspace.mdx @@ -299,67 +299,4 @@ For example, changing the **Chat Input** component's `input_value` will change t style={{ marginBottom: "20px", display: "flex", justifyContent: "center" }} > - - -## Collection - -A collection is a snapshot of flows available in a database. - -Collections can be downloaded to local storage and uploaded for future use. - -
- -
- -## Project - -A **Project** can be a flow or a component. To view your saved projects, select **My Collection**. - -Your **Projects** are displayed. - -Click the **![Playground icon](/logos/botmessage.svg) Playground** button to run a flow from the **My Collection** screen. - -In the top left corner of the screen are options for **Download Collection**, **Upload Collection**, and **New Project**. - -Select **Download Collection** to save your project to your local machine. This downloads all flows and components as a `.json` file. - -Select **Upload Collection** to upload a flow or component `.json` file from your local machine. - -Select **New Project** to create a new project. In addition to a blank workspace, [starter projects](../starter-projects/basic-prompting) are also available. - -## Project options menu - -To see options for your project, in the upper left corner of the workspace, select the dropdown menu. - - - -**New** - Start a new project. - -**Duplicate** - Duplicate the current flow as a new project. - -**Settings** - Modify the project's **Name** or **Description**. - -**Import** - Upload a flow `.json` file from your local machine. - -**Export** - Download your current project to your local machine as a `.json` file. - -**Undo** or **Redo** - Undo or redo your last action. - -## Project folders - -As of Langflow 1.0 alpha, more options are available for storing projects with **folders**. - -Create new folders with the **New folder** button. One folder can store multiple projects (as the default My Projects folder does). - -You can download folders of projects as a single JSON file, and upload files and flows to your folder. - -Click the **Trash** icon to delete a folder. + \ No newline at end of file diff --git a/docs/sidebars.js b/docs/sidebars.js index 65ef4db24..491b1ce6e 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -40,6 +40,7 @@ module.exports = { "administration/login", "administration/cli", "administration/playground", + "administration/collections-projects", "administration/settings", "administration/global-env", "administration/chat-widget", diff --git a/docs/static/img/my-collection.png b/docs/static/img/my-collection.png new file mode 100644 index 000000000..201b22a87 Binary files /dev/null and b/docs/static/img/my-collection.png differ