Skip to content

Commit

Permalink
docs: v0.2 version sidebar (#21844)
Browse files Browse the repository at this point in the history
  • Loading branch information
efriis committed May 17, 2024
1 parent e6b7a17 commit 9a39f92
Show file tree
Hide file tree
Showing 5 changed files with 30 additions and 13 deletions.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebar_label: Changes

This code contains a list of deprecations and removals in the `langchain` and `langchain-core` packages.

New features and improvements are not listed here. See the [overview](/docs/versions/v_02/overview) for a summary of what's new in this release.
New features and improvements are not listed here. See the [overview](/docs/versions/overview/) for a summary of what's new in this release.

## Breaking changes

Expand Down Expand Up @@ -88,7 +88,7 @@ Code that has better alternatives available and will eventually be removed, so t

### astream events V1

If you are using `astream_events`, please review how to [migrate to astream events v2](/docs/versions/v_02/migrating_astream_events).
If you are using `astream_events`, please review how to [migrate to astream events v2](/docs/versions/v0_2/migrating_astream_events).

### langchain_core

Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,20 @@
---
sidebar_position: 1
sidebar_label: Migration
---

# Migration
# LangChain v0.2



LangChain v0.2 was released in May 2024. This release includes a number of [breaking changes and deprecations](/docs/versions/v0_2/deprecations). This document contains a guide on upgrading to 0.2.x.

LangChain v0.2 was released in May 2024. This release includes a number of [breaking changes and deprecations](/docs/versions/v_02/deprecations). This document contains a guide on upgrading to 0.2.x.
:::note Reference

- [Breaking Changes & Deprecations](/docs/versions/v0_2/deprecations)

:::

# Migration

This documentation will help you upgrade your code to LangChain `0.2.x.`. To prepare for migration, we first recommend you take the following steps:

Expand All @@ -14,7 +23,6 @@ This documentation will help you upgrade your code to LangChain `0.2.x.`. To pre
3. Install a recent version of `langchain-cli` , and use the tool to replace old imports used by your code with the new imports. (See instructions below.)
4. Manually resolve any remaining deprecation warnings.
5. Re-run unit tests.
6. If you are using `astream_events`, please review how to [migrate to astream events v2](/docs/versions/v_02/migrating_astream_events).

## Upgrade to new imports

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ sidebar_label: astream_events v2

# Migrating to Astream Events v2

:::danger

This migration guide is a work in progress and is not complete. Please wait to migrate astream_events.

:::

We've added a `v2` of the astream_events API with the release of `0.2.0`. You can see this [PR](https://github.com/langchain-ai/langchain/pull/21638) for more details.

The `v2` version is a re-write of the `v1` version, and should be more efficient, with more consistent output for the events. The `v1` version of the API will be deprecated in favor of the `v2` version and will be removed in `0.4.0`.
Expand Down
17 changes: 10 additions & 7 deletions docs/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -69,18 +69,21 @@ module.exports = {
collapsed: false,
collapsible: false,
items: [
"versions/overview",
"versions/release_policy",
"versions/packages",
{
type: "category",
label: "v0.2",
items: [
{
type: "autogenerated",
dirName: "versions/v_02",
}
]
}
link: {type: 'doc', id: 'versions/v0_2/index'},
collapsible: false,
collapsed: false,
items: [{
type: 'autogenerated',
dirName: 'versions/v0_2',
className: 'hidden',
}],
},
],
},
"security"
Expand Down

0 comments on commit 9a39f92

Please sign in to comment.