Skip to content

Commit

Permalink
docs: links in integration contrib (#28200)
Browse files Browse the repository at this point in the history
  • Loading branch information
efriis authored Nov 19, 2024
1 parent 0dbaf05 commit 0a06732
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 9 deletions.
10 changes: 4 additions & 6 deletions docs/docs/contributing/how_to/integrations/community.mdx
Original file line number Diff line number Diff line change
@@ -1,13 +1,11 @@
## How to add a community integration (deprecated guide)
## How to add a community integration (not recommended)

:::danger

We are no longer accepting new community integrations. Please see the
[main integration guide](./index.mdx) for more information on contributing new
integrations.
We recommend following the [main integration guide](./index.mdx) to add new integrations instead.

Note that `langchain-community` is **not** deprecated. Only
the process for adding new community integrations is deprecated.
If you follow this guide, there is a high likelihood we will close your PR with the above
guide linked without much discussion.

:::

Expand Down
6 changes: 3 additions & 3 deletions docs/docs/contributing/how_to/integrations/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -65,10 +65,10 @@ that will render on this site (https://python.langchain.com/).

As a prerequisite to adding your integration to our documentation, you must:

1. Confirm that your integration is in the list of components we are currently accepting.
1. Confirm that your integration is in the [list of components](#components-to-integrate) we are currently accepting.
2. Ensure that your integration is in a separate package that can be installed with `pip install <your-package>`.
3. Implement the standard tests for your integration and successfully run them.
3. Write documentation for your integration in the `docs/docs/integrations` directory of the LangChain monorepo.
3. [Implement the standard tests](/docs/contributing/how_to/integrations/standard_tests) for your integration and successfully run them.
3. Write documentation for your integration in the `docs/docs/integrations/<component_type>` directory of the LangChain monorepo.
4. Add a provider page for your integration in the `docs/docs/integrations/providers` directory of the LangChain monorepo.

Once you have completed these steps, you can submit a PR to the LangChain monorepo to add your integration to the documentation.
Expand Down

0 comments on commit 0a06732

Please sign in to comment.