docs: mention upgrade notes (#874)

belgattitude · Jan 6, 2024 · 04c763e · 04c763e
1 parent 62332de
commit 04c763e
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 1 deletion.
diff --git a/docs/src/pages/exception/index.mdx b/docs/src/pages/exception/index.mdx
@@ -561,3 +561,13 @@ The export fields and the builds are checked on the CI with [are-the-types-wrong
 
 This library targets typescript 5+ with descriptions (see
 [the generated api docs](https://github.com/belgattitude/httpx/tree/main/packages/exception/docs/api)).
+
+## Upgrade
+
+> Refer to the [UPGRADE.md](https://github.com/belgattitude/httpx/blob/main/packages/exception/UPGRADE.md) for detailed information.
+
+| Version | Comment                                                             |
+|---------|---------------------------------------------------------------------|
+| 3.x     | Serializer functions don't include stack by default                 |
+| 2.x     | Node 18.x, modern browsers (see how to [transpile](#compatibility)) |
+
diff --git a/packages/exception/README.md b/packages/exception/README.md
@@ -584,9 +584,18 @@ The export fields and the builds are checked on the CI with [are-the-types-wrong
 This library targets typescript 5+ with descriptions (see
 [the generated api docs](https://github.com/belgattitude/httpx/tree/main/packages/exception/docs/api)).
 
+## Upgrade
+
+> Refer to the [UPGRADE.md](https://github.com/belgattitude/httpx/blob/main/packages/exception/UPGRADE.md) for detailed information.
+
+| Version | Comment                                                             |
+| ------- | ------------------------------------------------------------------- |
+| 3.x     | Serializer functions don't include stack by default                 |
+| 2.x     | Node 18.x, modern browsers (see how to [transpile](#compatibility)) |
+
 ## Support
 
-Don't hesitate and open [an issue](https://github.com/belgattitude/httpx/issues).
+Open [an issue on github](https://github.com/belgattitude/httpx/issues).
 
 ## Contributors
 

diff --git a/packages/exception/package.json b/packages/exception/package.json
@@ -83,6 +83,7 @@
   "files": [
     "dist",
     "README.md",
+    "UPGRADE.md",
     "package.json",
     "LICENSE",
     "CHANGELOG.md"