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 2024-11-25 15:26:58 -05:00 • committed by GitHub
commit 1b3785ee95
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
19 changed files with 16626 additions and 116 deletions

View file

@ -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;
};