docs: rename getting-started folder and add redirects (#4813)
* feat: add docusaurus preset for OpenAPI integration * feat: integrate OpenAPI plugins into Docusaurus configuration * plugins * feat: define custom sidebar structure for documentation * fix-folder-name-and-redirect
This commit is contained in:
Mendon Kissling
GitHub
parent
394cc55ab7
commit
1b3785ee95
19 changed files with 16626 additions and 116 deletions
|
|
@ -9,7 +9,7 @@
|
|||
<p align="center" style="font-size: 12px;">
|
||||
<a href="https://docs.langflow.org" style="text-decoration: underline;">Docs</a> -
|
||||
<a href="https://astra.datastax.com/signup?type=langflow" style="text-decoration: underline;">Free Cloud Service</a> -
|
||||
<a href="https://docs.langflow.org/getting-started-installation" style="text-decoration: underline;">Self Managed</a>
|
||||
<a href="https://docs.langflow.org/get-started-installation" style="text-decoration: underline;">Self Managed</a>
|
||||
|
||||
</p>
|
||||
|
||||
|
|
@ -46,7 +46,7 @@ pip install langflow
|
|||
```
|
||||
|
||||
- **Cloud:** DataStax Langflow is a hosted environment with zero setup. [Sign up for a free account.](https://astra.datastax.com/signup?type=langflow)
|
||||
- **Self-managed:** Run Langflow in your environment. [Install Langflow](https://docs.langflow.org/getting-started-installation) to run a local Langflow server, and then use the [Quickstart](https://docs.langflow.org/getting-started-quickstart) guide to create and execute a flow.
|
||||
- **Self-managed:** Run Langflow in your environment. [Install Langflow](https://docs.langflow.org/get-started-installation) to run a local Langflow server, and then use the [Quickstart](https://docs.langflow.org/get-started-quickstart) guide to create and execute a flow.
|
||||
- **Hugging Face:** [Clone the space using this link](https://huggingface.co/spaces/Langflow/Langflow?duplicate=true) to create a Langflow workspace.
|
||||
|
||||
[](https://www.youtube.com/watch?v=kinngWhaUKM)
|
||||
|
|
|
|||
|
|
@ -22,7 +22,7 @@ However, you can use these same instructions as guidelines for using any type of
|
|||
|
||||
### Prerequisites
|
||||
|
||||
- [Langflow is installed](/getting-started-installation)
|
||||
- [Langflow is installed](/get-started-installation)
|
||||
- [You have an OpenAI API key](https://platform.openai.com/)
|
||||
- [You have a Langflow Basic Prompting flow](/starter-projects-basic-prompting)
|
||||
|
||||
|
|
|
|||
1
docs/docs/Get-Started/_category_.json
Normal file
1
docs/docs/Get-Started/_category_.json
Normal file
|
|
@ -0,0 +1 @@
|
|||
{"position":1, "label":"Get Started"}
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: Install Langflow
|
||||
sidebar_position: 1
|
||||
slug: /getting-started-installation
|
||||
slug: /get-started-installation
|
||||
---
|
||||
|
||||
You can deploy Langflow either locally or as a hosted service with [**Datastax Langflow**](#datastax-langflow).
|
||||
|
|
@ -40,7 +40,7 @@ python -m langflow run
|
|||
|
||||
2. Confirm that a local Langflow instance starts by visiting `http://127.0.0.1:7860` in a Chromium-based browser.
|
||||
|
||||
Now that Langflow is running, follow the [Quickstart](/getting-started-quickstart) to create your first flow.
|
||||
Now that Langflow is running, follow the [Quickstart](/get-started-quickstart) to create your first flow.
|
||||
|
||||
## Manage Langflow versions
|
||||
|
||||
|
|
@ -50,7 +50,7 @@ To upgrade Langflow to the latest version, use the pip upgrade command.
|
|||
python -m pip install langflow -U
|
||||
```
|
||||
|
||||
To install a specific verison of the Langflow package, add the required version to the command.
|
||||
To install a specific version of the Langflow package, add the required version to the command.
|
||||
|
||||
```bash
|
||||
python -m pip install langflow==1.1
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
title: Quickstart
|
||||
sidebar_position: 2
|
||||
slug: /getting-started-quickstart
|
||||
slug: /get-started-quickstart
|
||||
---
|
||||
|
||||
|
||||
|
|
@ -35,6 +35,6 @@ Join Langflow's vibrant community of developers and AI enthusiasts. See the foll
|
|||
|
||||
## Get started with Langflow
|
||||
|
||||
- [Install Langflow](/getting-started-installation)
|
||||
- [Quickstart](/getting-started-quickstart)
|
||||
- [Install Langflow](/get-started-installation)
|
||||
- [Quickstart](/get-started-quickstart)
|
||||
|
||||
|
|
@ -1 +0,0 @@
|
|||
{"position":1, "label":"Getting Started"}
|
||||
|
|
@ -9,7 +9,7 @@ slug: /guides-new-to-llms
|
|||
Large Language Models, or LLMs, are part of an exciting new world in computing.
|
||||
|
||||
|
||||
We made Langflow for anyone to create with LLMs, and hope you'll feel comfortable installing Langflow and [getting started](/getting-started-quickstart).
|
||||
We made Langflow for anyone to create with LLMs, and hope you'll feel comfortable installing Langflow and [getting started](/get-started-quickstart).
|
||||
|
||||
|
||||
If you want to learn the basics of LLMs, prompt engineering, and AI models, Langflow recommends [promptingguide.ai](https://promptingguide.ai/), an open-source repository of prompt engineering content maintained by AI experts. PromptingGuide offers content for [beginners](https://www.promptingguide.ai/introduction/basics) and [experts](https://www.promptingguide.ai/techniques/cot), as well as the latest [research papers](https://www.promptingguide.ai/papers) and [test results](https://www.promptingguide.ai/research) fueling AI's progress.
|
||||
|
|
|
|||
|
|
@ -20,7 +20,7 @@ This article demonstrates how to use Langflow's prompt tools to issue basic prom
|
|||
|
||||
---
|
||||
|
||||
- [Langflow installed and running](/getting-started-installation)
|
||||
- [Langflow installed and running](/get-started-installation)
|
||||
- [OpenAI API key created](https://platform.openai.com/)
|
||||
|
||||
## Create the basic prompting flow {#19d5305239c841548a695e2bf7839e7a}
|
||||
|
|
|
|||
|
|
@ -16,7 +16,7 @@ OpenAI uses this loaded data to generate a blog post, as instructed by the **Tex
|
|||
|
||||
---
|
||||
|
||||
- [Langflow installed and running](/getting-started-installation)
|
||||
- [Langflow installed and running](/get-started-installation)
|
||||
- [OpenAI API key created](https://platform.openai.com/)
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ Build a question-and-answer chatbot with a document loaded from local memory.
|
|||
|
||||
---
|
||||
|
||||
- [Langflow installed and running](/getting-started-installation)
|
||||
- [Langflow installed and running](/get-started-installation)
|
||||
- [OpenAI API key created](https://platform.openai.com/)
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ This flow extends the [basic prompting](/starter-projects-basic-prompting) flo
|
|||
|
||||
---
|
||||
|
||||
- [Langflow installed and running](/getting-started-installation)
|
||||
- [Langflow installed and running](/get-started-installation)
|
||||
- [OpenAI API key created](https://platform.openai.com/)
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -23,7 +23,7 @@ We've chosen [Astra DB](https://astra.datastax.com/signup?utm_source=langflow-p
|
|||
|
||||
---
|
||||
|
||||
- [Langflow installed and running](https://docs.langflow.org/getting-started-installation)
|
||||
- [Langflow installed and running](https://docs.langflow.org/get-started-installation)
|
||||
- [OpenAI API key](https://platform.openai.com/)
|
||||
- [An Astra DB vector database created](https://docs.datastax.com/en/astra-db-serverless/get-started/quickstart.html) with:
|
||||
- Application Token
|
||||
|
|
|
|||
|
|
@ -29,12 +29,16 @@ const config = {
|
|||
|
||||
presets: [
|
||||
[
|
||||
"@docusaurus/preset-classic",
|
||||
"docusaurus-preset-openapi",
|
||||
/** @type {import('@docusaurus/preset-classic').Options} */
|
||||
({
|
||||
api: {
|
||||
path: "openapi.json", // Path to your OpenAPI file
|
||||
routeBasePath: "/api", // The base URL for your API docs
|
||||
},
|
||||
docs: {
|
||||
routeBasePath: "/", // Serve the docs at the site's root
|
||||
sidebarPath: undefined, // `undefined` to create a fully autogenerated sidebar.
|
||||
sidebarPath: require.resolve("./sidebars.js"), // Use sidebars.js file
|
||||
sidebarCollapsed: false,
|
||||
beforeDefaultRemarkPlugins: [
|
||||
[
|
||||
|
|
@ -88,11 +92,19 @@ const config = {
|
|||
from: [
|
||||
"/whats-new-a-new-chapter-langflow",
|
||||
"/👋 Welcome-to-Langflow",
|
||||
"/getting-started-welcome-to-langflow"
|
||||
],
|
||||
},
|
||||
{
|
||||
to: "/getting-started-installation",
|
||||
from: "/getting-started-common-installation-issues",
|
||||
to: "/get-started-installation",
|
||||
from: [
|
||||
"/getting-started-installation",
|
||||
"/getting-started-common-installation-issues",
|
||||
],
|
||||
},
|
||||
{
|
||||
to: "/get-started-quickstart",
|
||||
from: "/getting-started-quickstart",
|
||||
},
|
||||
{
|
||||
to: "/workspace-overview",
|
||||
|
|
|
|||
9323
docs/openapi.json
Normal file
9323
docs/openapi.json
Normal file
File diff suppressed because it is too large
Load diff
4816
docs/package-lock.json
generated
4816
docs/package-lock.json
generated
File diff suppressed because it is too large
Load diff
|
|
@ -23,6 +23,9 @@
|
|||
"clsx": "^1.2.1",
|
||||
"docusaurus-node-polyfills": "^1.0.0",
|
||||
"docusaurus-plugin-image-zoom": "^2.0.0",
|
||||
"docusaurus-plugin-openapi-docs": "^4.2.0",
|
||||
"docusaurus-preset-openapi": "^0.7.5",
|
||||
"docusaurus-theme-openapi-docs": "^4.2.0",
|
||||
"lucide-react": "^0.460.0",
|
||||
"prism-react-renderer": "^1.3.5",
|
||||
"react": "^18.2.0",
|
||||
|
|
|
|||
171
docs/sidebars.js
171
docs/sidebars.js
|
|
@ -1,31 +1,148 @@
|
|||
/**
|
||||
* Creating a sidebar enables you to:
|
||||
- create an ordered group of docs
|
||||
- render a sidebar for each doc of that group
|
||||
- provide next/previous navigation
|
||||
|
||||
The sidebars can be generated from the filesystem, or explicitly defined here.
|
||||
|
||||
Create as many sidebars as you want.
|
||||
*/
|
||||
|
||||
// @ts-check
|
||||
|
||||
/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
|
||||
const sidebars = {
|
||||
// By default, Docusaurus generates a sidebar from the docs folder structure
|
||||
tutorialSidebar: [{type: 'autogenerated', dirName: '.'}],
|
||||
|
||||
// But you can create a sidebar manually
|
||||
/*
|
||||
tutorialSidebar: [
|
||||
module.exports = {
|
||||
docs: [
|
||||
'Get-Started/welcome-to-langflow',
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Tutorial',
|
||||
items: ['hello'],
|
||||
label: 'Get Started',
|
||||
items: [
|
||||
'Get-Started/get-started-installation',
|
||||
'Get-Started/get-started-quickstart',
|
||||
'Get-Started/welcome-to-langflow',
|
||||
],
|
||||
},
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Components',
|
||||
items: [
|
||||
'Components/components-overview',
|
||||
'Components/components-agents',
|
||||
'Components/components-custom-components',
|
||||
'Components/components-data',
|
||||
'Components/components-embedding-models',
|
||||
'Components/components-helpers',
|
||||
'Components/components-io',
|
||||
'Components/components-loaders',
|
||||
'Components/components-logic',
|
||||
'Components/components-memories',
|
||||
'Components/components-models',
|
||||
'Components/components-prompts',
|
||||
'Components/components-rag',
|
||||
'Components/components-tools',
|
||||
'Components/components-vector-stores',
|
||||
],
|
||||
},
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Agents',
|
||||
items: [
|
||||
'Agents/agents-overview',
|
||||
'Agents/agent-tool-calling-agent-component',
|
||||
],
|
||||
},
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Configuration',
|
||||
items: [
|
||||
'Configuration/configuration-api-keys',
|
||||
'Configuration/configuration-authentication',
|
||||
'Configuration/configuration-auto-saving',
|
||||
'Configuration/configuration-backend-only',
|
||||
'Configuration/configuration-cli',
|
||||
'Configuration/configuration-global-variables',
|
||||
'Configuration/environment-variables',
|
||||
],
|
||||
},
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Guides',
|
||||
items: [
|
||||
'Guides/guides-chat-memory',
|
||||
'Guides/guides-data-message',
|
||||
'Guides/guides-new-to-llms',
|
||||
],
|
||||
},
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Integrations',
|
||||
items: [
|
||||
'Integrations/integrations-assemblyai',
|
||||
'Integrations/integrations-langfuse',
|
||||
'Integrations/integrations-langsmith',
|
||||
'Integrations/integrations-langwatch',
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Google',
|
||||
items: ['Integrations/Google/integrations-setup-google-oauth-langflow'],
|
||||
},
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Notion',
|
||||
items: [
|
||||
'Integrations/Notion/integrations-notion',
|
||||
'Integrations/Notion/notion-agent-conversational',
|
||||
'Integrations/Notion/notion-agent-meeting-notes',
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Starter Projects',
|
||||
items: [
|
||||
'Starter-Projects/starter-projects-basic-prompting',
|
||||
'Starter-Projects/starter-projects-blog-writer',
|
||||
'Starter-Projects/starter-projects-document-qa',
|
||||
'Starter-Projects/starter-projects-dynamic-agent',
|
||||
'Starter-Projects/starter-projects-memory-chatbot',
|
||||
'Starter-Projects/starter-projects-simple-agent',
|
||||
'Starter-Projects/starter-projects-travel-planning-agent',
|
||||
'Starter-Projects/starter-projects-vector-store-rag',
|
||||
],
|
||||
},
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Workspace',
|
||||
items: [
|
||||
'Workspace/workspace-overview',
|
||||
'Workspace/workspace-api',
|
||||
'Workspace/workspace-logs',
|
||||
'Workspace/workspace-playground',
|
||||
],
|
||||
},
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Contributing',
|
||||
items: [
|
||||
'Contributing/contributing-community',
|
||||
'Contributing/contributing-components',
|
||||
'Contributing/contributing-github-discussion-board',
|
||||
'Contributing/contributing-github-issues',
|
||||
'Contributing/contributing-how-to-contribute',
|
||||
'Contributing/contributing-telemetry',
|
||||
],
|
||||
},
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Deployment',
|
||||
items: [
|
||||
'Deployment/deployment-docker',
|
||||
'Deployment/deployment-gcp',
|
||||
'Deployment/deployment-hugging-face-spaces',
|
||||
'Deployment/deployment-kubernetes',
|
||||
'Deployment/deployment-railway',
|
||||
'Deployment/deployment-render',
|
||||
],
|
||||
},
|
||||
{
|
||||
type: 'category',
|
||||
label: 'API Reference',
|
||||
items: [
|
||||
{
|
||||
type: 'link',
|
||||
label: 'API Documentation',
|
||||
href: '/api',
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
*/
|
||||
};
|
||||
|
||||
module.exports = sidebars;
|
||||
};
|
||||
2377
docs/yarn.lock
2377
docs/yarn.lock
File diff suppressed because it is too large
Load diff
Loading…
Add table
Add a link
Reference in a new issue