📝 docs(CNAME): update the CNAME file to point to the new domain for the documentation
🔧 fix(ApiModal/index.tsx): update the links in the description to point to the correct documentation URL
🔧 fix(custom-component.mdx): correct the recommended way to load custom components by setting LANGFLOW_COMPONENTS_PATH environment variable instead of using --components-path argument
💡 docs(custom-component.mdx): provide an alternative method to specify the path to custom components using --components-path argument
📝 docs(custom-component.mdx): update folder structure section to include custom agents directory
📝 docs(custom-component.mdx): add instructions for specifying the path to custom components using the Langflow CLI
📝 docs(custom-component.mdx): add instructions for setting the LANGFLOW_COMPONENTS_PATH environment variable
📝 docs(custom-component.mdx): clarify that Langflow will continue loading components even if there are errors in some of them
📝 docs(custom-component.mdx): add section on interacting with custom components in Langflow's sidebar
The change clarifies that using a `Document` as input in the `FlowRunner` class is a straightforward way to pass text data in Langflow, specifically because it can be connected to many loaders. It also mentions that generally, a flow expects a string or a dictionary as input. Additionally, it updates the explanation of extracting the content of a document using the `page_content` attribute, which is a string.
The commit adds an explanation about using a `Document` as input in the `FlowRunner` class. It clarifies that using a `Document` is a straightforward way to pass text data in Langflow. Typically, a flow expects a string or a dictionary as input, and if a dictionary is used, it should be built according to the needs of the specific flow. The commit also mentions that the content of a document can be extracted using the `page_content` property and passed as an argument to the selected flow.
🔀 docs(custom.mdx): merge changes from the CustomComponent class documentation
📝 docs(custom.mdx): improve readability and formatting in the CustomComponent class documentation
🔀 docs(custom.mdx): merge changes from the CustomComponent class documentation
📝 docs(custom.mdx): update CustomComponent class documentation with additional methods and descriptions
🔀 docs(custom.mdx): merge changes from the CustomComponent class documentation
📝 docs(custom.mdx): update CustomComponent class documentation with corrected method names and descriptions
🔀 docs(custom.mdx): merge changes from the CustomComponent class documentation
ℹ️ The example code demonstrates how to create a custom component called "Flow Runner" that runs other flows using a document as input. The code includes the implementation of the `build_config` and `build` methods.
✨ feat(flow-runner.mdx): add example code for a Flow Runner custom component to provide a practical example for users to follow
🐛 fix(flow-runner.mdx): remove unnecessary focus annotations in code snippets
✨ feat(flow-runner.mdx): add support for getting flow by name instead of id in build method
✨ feat(flow-runner.mdx): add caution about unique flow names in version 0.4.0
✨ feat(flow-runner.mdx): add support for passing document parameter in build method
🐛 fix(flow-runner.mdx): remove redundant Optional type hint for document parameter in build method
🐛 fix(flow-runner.mdx): remove empty line at the end of the file
🐛 fix(custom.mdx): add missing punctuation in the field descriptions
✨ feat(custom.mdx): add clarification to the field descriptions and provide examples for some fields
📝 docs(custom.mdx): add missing punctuation in the method description
🐛 fix(custom.mdx): add comment to clarify the purpose of the line
🔧 chore(docs): fix formatting in chat-widget.mdx file
🎨 style(components.mdx): Remove unnecessary div wrapper and fix indentation
🎨 style(features.mdx): Remove unnecessary div wrapper and fix indentation
🎨 style(prompt-customization.mdx): Remove unnecessary div wrappers and fix indentation
🎨 style(index.mdx): Remove unnecessary div wrapper and fix indentation
The changes in this commit update the documentation for the Custom Component.
- Clarify that the code must be a class that inherits from the `langflow.CustomComponent` class.
- Explain that the type annotations of the `build` instance method are used to create the fields of the component.
- Provide a table of supported types for the `build` method.
- Introduce the `build_config` instance method for defining configuration fields.
- Describe the format and available keys for the `build_config` method.
- Add usage example for the `build` method.
These changes improve the clarity and completeness of the documentation for the Custom Component, making it easier for users to understand and utilize this feature.
🐛 fix(custom-component.mdx): change class name from BestComponent to DocumentProcessor to improve semantics and clarity
✨ feat(custom-component.mdx): add support for processing the page content of a document based on a selected function
📝 docs(custom-component.mdx): update example and explanations to reflect the changes made in the code
🐛 fix(custom-component.mdx): fix code indentation and remove unused imports
✨ feat(custom-component.mdx): update component name and description to improve clarity and semantics
🐛 fix(custom-component.mdx): update build method parameters and return type to match the actual implementation
✨ feat(custom-component.mdx): add support for configuring fields in the build_config method
🐛 fix(custom-component.mdx): fix code indentation and remove unused imports in the build_config method
✨ feat(custom-component.mdx): add support for configuring fields in the build_config method
✨ feat(custom-component.mdx): add rules and explanations for creating custom components
📝 docs(custom-component.mdx): update rule 1 to specify that the script must contain a single class inheriting from CustomComponent
📝 docs(custom-component.mdx): update rule 2 to specify that the class must have a build method
📝 docs(custom-component.mdx): update rule 3 to specify that the type annotations of the build method will be used to create the fields of the component
📝 docs(custom-component.mdx): update rule 4 to specify that the class can have a build_config method
📝 docs(custom-component.mdx): update rule 4 to provide details on the format of the build_config method
📝 docs(custom-component.mdx): update rule 4 to correct a typo in the display_name key
📝 docs(custom-component.mdx): update rule 4 to provide additional details on the options and multiline keys in the build_config method
📝 docs(custom-component.mdx): add example for creating a FlowRunner component
📝 docs(custom-component.mdx): update example for creating a FlowRunner component to include display_name and description attributes
📝 docs(custom-component.mdx): update example for creating a FlowRunner component to import Document from the schema module
📝 docs(custom-component.mdx): update example for creating a FlowRunner component to add parameters and return type to the build method
