-
Notifications
You must be signed in to change notification settings - Fork 4.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into nd-integration
- Loading branch information
Showing
133 changed files
with
12,193 additions
and
1,387 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,5 @@ | ||
| --- | ||
| title: API Keys | ||
| title: API keys | ||
| sidebar_position: 1 | ||
| slug: /configuration-api-keys | ||
| --- | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,52 +1,26 @@ | ||
| --- | ||
| title: Community | ||
| sidebar_position: 3 | ||
| title: Join the Langflow community | ||
| sidebar_position: 5 | ||
| slug: /contributing-community | ||
| --- | ||
|
|
||
|
|
||
|
|
||
| ## 🤖 Join **Langflow** Discord server {#80011e0bda004e83a8012c7ec6eab29a} | ||
| ## Join the Langflow Discord server | ||
|
|
||
| Join the [Langflow Discord Server](https://discord.gg/EqksyE2EX9) to ask questions and showcase your projects. | ||
|
|
||
| --- | ||
|
|
||
|
|
||
| Join us to ask questions and showcase your projects. | ||
|
|
||
|
|
||
| Let's bring together the building blocks of AI integration! | ||
|
|
||
|
|
||
| Langflow [Discord](https://discord.gg/EqksyE2EX9) server. | ||
|
|
||
|
|
||
| ## 🐦 Stay tuned for **Langflow** on Twitter {#6a17ba5905ad4f7aa5347af7854779f6} | ||
|
|
||
|
|
||
| --- | ||
| ## Follow Langflow on X | ||
|
|
||
| Follow [@langflow_ai](https://twitter.com/langflow_ai) on X to get the latest news about Langflow. | ||
|
|
||
| Follow [@langflow_ai](https://twitter.com/langflow_ai) on **Twitter** to get the latest news about **Langflow**. | ||
| ## Star Langflow on GitHub | ||
|
|
||
| You can [star Langflow in GitHub](https://github.com/langflow-ai/langflow). | ||
|
|
||
| ## ⭐️ Star **Langflow** on GitHub {#c903a569934643799bf52b7d1b3514e1} | ||
|
|
||
|
|
||
| --- | ||
|
|
||
|
|
||
| You can "star" **Langflow** in [GitHub](https://github.com/langflow-ai/langflow). | ||
|
|
||
|
|
||
| By adding a star, other users will be able to find it more easily and see that it has been already useful for others. | ||
|
|
||
|
|
||
| ## 👀 Watch the GitHub repository for releases {#d0a089ed717742308bd17430e5ae6309} | ||
|
|
||
|
|
||
| --- | ||
| By adding a star, other users will be able to find Langflow more easily, and see that it has been already useful for others. | ||
|
|
||
| ## Watch the GitHub repository for releases | ||
|
|
||
| You can "watch" **Langflow** in [GitHub](https://github.com/langflow-ai/langflow). If you select "Watching" instead of "Releases only" you will receive notifications when someone creates a new issue or question. You can also specify that you only want to be notified about new issues, discussions, PRs, etc. so you can try and help them solve those questions. | ||
| You can [watch Langflow in GitHub](https://github.com/langflow-ai/langflow). If you select **Watching** instead of **Releases only** you will receive notifications when someone creates a new issue or question. You can also specify that you want to be notified only about new issues, discussions, and PRs so you can try to help solve those issues. | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| --- | ||
| title: Contribute components | ||
| sidebar_position: 4 | ||
| slug: /contributing-components | ||
| --- | ||
|
|
||
|
|
||
| New components are added as objects of the [CustomComponent](https://github.com/langflow-ai/langflow/blob/dev/src/backend/base/langflow/custom/custom_component/custom_component.py) class. | ||
|
|
||
| Any dependencies are added to the [pyproject.toml](https://github.com/langflow-ai/langflow/blob/main/pyproject.toml#L148) file. | ||
|
|
||
| ### Contribute an example component to Langflow | ||
|
|
||
| Anyone can contribute an example component. For example, if you created a new document loader called **MyCustomDocumentLoader**, you can follow these steps to contribute it to Langflow. | ||
|
|
||
| 1. Write your loader as an object of the [CustomComponent](https://github.com/langflow-ai/langflow/blob/dev/src/backend/base/langflow/custom/custom_component/custom_component.py) class. You'll create a new class, `MyCustomDocumentLoader`, that will inherit from `CustomComponent` and override the base class's methods. | ||
| 2. Define optional attributes like `display_name`, `description`, and `documentation` to provide information about your custom component. | ||
| 3. Implement the `build_config` method to define the configuration options for your custom component. | ||
| 4. Implement the `build` method to define the logic for taking input parameters specified in the `build_config` method and returning the desired output. | ||
| 5. Add the code to the [/components/documentloaders](https://github.com/langflow-ai/langflow/tree/dev/src/backend/base/langflow/components) folder. | ||
| 6. Add the dependency to [/documentloaders/__init__.py](https://github.com/langflow-ai/langflow/blob/dev/src/backend/base/langflow/components/documentloaders/__init__.py) as `from .MyCustomDocumentLoader import MyCustomDocumentLoader`. | ||
| 7. Add any new dependencies to the [pyproject.toml](https://github.com/langflow-ai/langflow/blob/main/pyproject.toml#L148) file. | ||
| 8. Submit documentation for your component. For this example, you'd submit documentation to the [loaders page](https://github.com/langflow-ai/langflow/blob/main/docs/docs/Components/components-loaders.md). | ||
| 9. Submit your changes as a pull request. The Langflow team will have a look, suggest changes, and add your component to Langflow. |
13 changes: 13 additions & 0 deletions
13
docs/docs/Contributing/contributing-github-discussion-board.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| --- | ||
| title: Ask for help on the Discussions board | ||
| sidebar_position: 3 | ||
| slug: /contributing-github-discussions | ||
| --- | ||
|
|
||
| If you're looking for help with your code, consider posting a question on the Langflow [GitHub Discussions board](https://github.com/langflow-ai/langflow/discussions). The Langflow team cannot provide individual support via email. The team also believes that help is much more valuable if it's shared publicly, so that more people can benefit from it. | ||
|
|
||
| Since the Discussions board is public, please follow this guidance when posting your code questions. | ||
|
|
||
| * When describing your issue, try to provide as many details as possible. What exactly goes wrong? _How_ is it failing? Is there an error? "XY doesn't work" usually isn't that helpful for tracking down problems. Always remember to include the code you ran and if possible, extract only the relevant parts and don't just dump your entire script. This will make it easier for us to reproduce the error. | ||
|
|
||
| * When you include long code, logs, or tracebacks, wrap them in `<details>` and `</details>` tags. This [collapses the content](https://developer.mozilla.org/en/docs/Web/HTML/Element/details) so the contents only becomes visible on click, making the issue easier to read and follow. |
Oops, something went wrong.