[Docs] - Refactor folders and leftnav (#1781)

* refactor-leftnav

* bump-whats-new

* comment-out-some-tutorials

* links

* guidelines

* comma

* starter-projects

* try-links

* add-new-component-location
This commit is contained in:
Mendon Kissling 2024-04-30 08:28:59 -04:00 committed by GitHub
commit cc70a11572
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
27 changed files with 83 additions and 97 deletions

View file

@ -12,7 +12,7 @@ To use a custom component, follow these steps:
<Admonition type="info" label="Tip">
For an in-depth explanation of custom components, their rules, and applications, make sure to read [Custom Component guidelines](../guidelines/custom-component).
For an in-depth explanation of custom components, their rules, and applications, make sure to read [Custom Component guidelines](../administration/custom-component).
</Admonition>
@ -57,7 +57,7 @@ The CustomComponent class serves as the foundation for creating custom component
<Admonition type="info">
Unlike Langchain types, base Python types do not add a
[handle](../guidelines/components) to the field by default. To add handles,
[handle](../administration/components) to the field by default. To add handles,
use the _`input_types`_ key in the _`build_config`_ method.
</Admonition>

View file

@ -21,7 +21,7 @@ The `PromptTemplate` component allows users to create prompts and define variabl
<Admonition type="info">
Once a variable is defined in the prompt template, it becomes a component
input of its own. Check out [Prompt
Customization](../guidelines/prompt-customization) to learn more.
Customization](../administration/prompt-customization) to learn more.
</Admonition>
- **template:** Template used to format an individual request.

View file

@ -159,7 +159,7 @@ Now, let's add the [parameters](focus://11[20:55]) and the [return type](focus:/
- _`flow_name`_ is the name of the flow we want to run.
- _`document`_ is the input document to be passed to that flow.
- Since _`Document`_ is a Langchain type, it will add an input [handle](../guidelines/components) to the component ([see more](../components/custom)).
- Since _`Document`_ is a Langchain type, it will add an input [handle](../administration/components) to the component ([see more](../components/custom)).
---
@ -242,7 +242,7 @@ class FlowRunner(CustomComponent):
```
You can load this flow using _`get_flow`_ and set a _`tweaks`_ dictionary to customize it. Find more about tweaks in our [features guidelines](../guidelines/features#code).
You can load this flow using _`get_flow`_ and set a _`tweaks`_ dictionary to customize it. Find more about tweaks in our [features guidelines](../administration/features#code).
---

View file

@ -112,8 +112,8 @@ Well done! You've built your first prompt in Langflow. 🎉
By adding Langflow components to this prompt, you can build all sorts of interesting flows.
* [Memory chatbot](/guides/memory-chatbot.mdx)
* [Blog writer](/guides/blog-writer.mdx)
* [Document QA](/guides/document-qa.mdx)
* [Memory chatbot](/starter-projects/memory-chatbot.mdx)
* [Blog writer](/starter-projects/blog-writer.mdx)
* [Document QA](/starter-projects/document-qa.mdx)

View file

@ -35,4 +35,4 @@ Use Langflow's simple but powerful UI to build any AI application you can dream
Learn more about the exciting changes in Langflow 1.0, and how to migrate your existing Langflow projects.
* [A new chapter for Langflow](/whats-new/a-new-chapter-langflow)
* [Migration guides](/whats-new/migrating-to-one-point-zero)
* [Migration guides](/migration/migrating-to-one-point-zero)

View file

@ -61,11 +61,11 @@ We wanted to create start projects that would help you learn about new features
For now, we have:
- **[Basic Prompting (Hello, World)](/guides/basic-prompting)**: A simple flow that shows you how to use the Prompt Component and how to talk like a pirate.
- **[Vector Store RAG](/guides/rag-with-astradb)**: A flow that shows you how to ingest data into a Vector Store and then use it to run a RAG application.
- **[Memory Chatbot](/guides/memory-chatbot)**: This one shows you how to create a simple chatbot that can remember things about the user.
- **[Document QA](/guides/document-qa)**: This flow shows you how to build a simple flow that helps you get answers about a document.
- **[Blog Writer](/guides/blog-writer)**: Shows you how you can expand on the Prompt variables and be creative about what inputs you add to it.
- **[Basic Prompting (Hello, World)](/starter-projects/basic-prompting)**: A simple flow that shows you how to use the Prompt Component and how to talk like a pirate.
- **[Vector Store RAG](/tutorials/rag-with-astradb)**: A flow that shows you how to ingest data into a Vector Store and then use it to run a RAG application.
- **[Memory Chatbot](/starter-projects/memory-chatbot)**: This one shows you how to create a simple chatbot that can remember things about the user.
- **[Document QA](/starter-projects/document-qa)**: This flow shows you how to build a simple flow that helps you get answers about a document.
- **[Blog Writer](/starter-projects/blog-writer)**: Shows you how you can expand on the Prompt variables and be creative about what inputs you add to it.
As always, your feedback is invaluable, so please let us know what you think of the new starter projects and what you would like to see in the future.

View file

@ -2,88 +2,49 @@ module.exports = {
docs: [
{
type: "category",
label: " Getting Started",
label: "What's New?",
collapsed: false,
items: [
"whats-new/a-new-chapter-langflow"
],
},
{
type: "category",
label: "Getting Started",
collapsed: false,
items: [
"index",
"getting-started/install-langflow",
"getting-started/quickstart",
"getting-started/huggingface-spaces",
"getting-started/new-to-llms",
"getting-started/new-to-llms"
],
},
{
type: "category",
label: " Starter Projects",
label: "Starter Projects",
collapsed: false,
items: [
"guides/basic-prompting",
"guides/blog-writer",
"guides/document-qa",
"guides/memory-chatbot",
"guides/rag-with-astradb",
"starter-projects/basic-prompting",
"starter-projects/blog-writer",
"starter-projects/document-qa",
"starter-projects/memory-chatbot"
],
},
{
type: "category",
label: " What's New",
label: "Administration",
collapsed: false,
items: [
"whats-new/a-new-chapter-langflow",
"whats-new/migrating-to-one-point-zero",
"administration/login",
"administration/api",
"administration/cli",
"administration/components",
"administration/collection",
"administration/prompt-customization",
"administration/langfuse_integration"
],
},
{
type: "category",
label: " Migration Guides",
collapsed: false,
items: [
"migration/possible-installation-issues",
// "migration/flow-of-data",
"migration/inputs-and-outputs",
// "migration/supported-frameworks",
// "migration/sidebar-and-interaction-panel",
// "migration/new-categories-and-components",
"migration/text-and-record",
// "migration/custom-component",
"migration/compatibility",
// "migration/multiple-flows",
// "migration/component-status-and-data-passing",
// "migration/connecting-output-components",
// "migration/renaming-and-editing-components",
// "migration/passing-tweaks-and-inputs",
"migration/global-variables",
// "migration/experimental-components",
// "migration/state-management",
//"guides/rag-with-astradb",
],
},
{
type: "category",
label: "Guidelines",
collapsed: false,
items: [
"getting-started/cli",
"guidelines/login",
"guidelines/api",
"guidelines/components",
// "guidelines/features",
"guidelines/collection",
"guidelines/prompt-customization",
// "guidelines/chat-interface",
// "guidelines/chat-widget",
// "guidelines/custom-component",
],
},
{
type: "category",
label: "Extended Components",
collapsed: false,
items: ["guides/langfuse_integration"],
},
{
type: "category",
label: "Core Components",
@ -96,45 +57,69 @@ module.exports = {
"components/helpers",
"components/vector-stores",
"components/embeddings",
"components/custom"
],
},
{
type: "category",
label: "Extended Components",
collapsed: false,
collapsed: true,
items: [
"components/agents",
"components/chains",
"components/loaders",
"components/experimental",
"components/utilities",
"components/memories",
"components/model_specs",
"components/retrievers",
"components/text-splitters",
"components/toolkits",
"components/tools",
"components/tools"
],
},
{
type: "category",
label: "Example Components",
collapsed: true,
items: [
"examples/flow-runner",
"examples/conversation-chain",
"examples/buffer-memory",
"examples/csv-loader",
"examples/searchapi-tool",
"examples/serp-api-tool",
"examples/python-function"
],
},
{
type: "category",
label: "Migration Guides",
collapsed: false,
items: [
"migration/possible-installation-issues",
"migration/migrating-to-one-point-zero",
"migration/inputs-and-outputs",
"migration/text-and-record",
"migration/compatibility",
"migration/global-variables"
]
},
{
type: "category",
label: "Tutorials",
collapsed: true,
items: [
"tutorials/chatprompttemplate_guide",
"tutorials/loading_document",
"tutorials/rag-with-astradb"
],
},
// {
// type: "category",
// label: "Examples",
// collapsed: false,
// items: [
// // "examples/flow-runner",
// // "examples/conversation-chain",
// // "examples/buffer-memory",
// // "examples/csv-loader",
// // "examples/searchapi-tool",
// // "examples/serp-api-tool",
// // "examples/python-function",
// ],
// },
{
type: "category",
label: "Deployment",
collapsed: false,
items: ["deployment/gcp-deployment"],
collapsed: true,
items: [
"deployment/gcp-deployment"
],
},
{
type: "category",
@ -143,7 +128,7 @@ module.exports = {
items: [
"contributing/how-contribute",
"contributing/github-issues",
"contributing/community",
"contributing/community"
],
},
],

View file

@ -232,3 +232,4 @@ output_parsers:
custom_components:
CustomComponent:
documentation: "https://docs.langflow.org/guidelines/custom-component"
# documentation: "https://docs.langflow.org/administration/custom-component"