From ef7b40f23c7d598e2c545ed1b1fa9ccf6a5ae2bc Mon Sep 17 00:00:00 2001 From: reeshika-h Date: Thu, 9 Apr 2026 16:11:46 +0530 Subject: [PATCH] Update documentation to reflect deprecation of the Contentstack Dart SDK and provide migration guidance to the Content Delivery API. Added deprecation notice in CHANGELOG and README. --- CHANGELOG.md | 6 ++++++ DEPRECATION.md | 25 +++++++++++++++++++++++++ README.md | 6 ++++++ 3 files changed, 37 insertions(+) create mode 100644 DEPRECATION.md diff --git a/CHANGELOG.md b/CHANGELOG.md index 98bb409..be5c42b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,11 @@ # CHANGELOG +### **APR-09-2026** + +#### Documentation + +- Add deprecation notice and migration guidance to the Content Delivery API. See [DEPRECATION.md](DEPRECATION.md). + ### **JAN-12-2026** #### v1.0.2 - Improved Error messages diff --git a/DEPRECATION.md b/DEPRECATION.md new file mode 100644 index 0000000..0bef329 --- /dev/null +++ b/DEPRECATION.md @@ -0,0 +1,25 @@ +# Deprecation notice: Contentstack Dart SDK (pub.dev) + +This page is for **developers using the Contentstack Dart SDK** published on **pub.dev** as [`contentstack`](https://pub.dev/packages/contentstack). + +## What this means for you + +**We are deprecating this SDK as the recommended path for new Dart and Flutter work.** If you are **starting a new project**, use our **[Content Delivery API (CDA)](https://www.contentstack.com/docs/developers/apis/content-delivery-api/)** directly with your preferred HTTP client (for example `package:http` or your app’s existing networking stack). + +**If you already ship an app** that depends on `contentstack`, you can **keep using it**. Your integration continues to work. Plan a move to direct CDA usage when it fits your release schedule—you do not have to change immediately. + +## What to use for new projects + +| | Link | +|---|------| +| **Content Delivery API** | [Content Delivery API documentation](https://www.contentstack.com/docs/developers/apis/content-delivery-api/) | + +## Why we are making this change + +We are focusing investment on **direct API usage** and **documented integration patterns** for Dart and Flutter. This repository will remain in **maintenance**: we may address critical or security issues where we can, but **we do not plan new features** in the Dart SDK. + +## Support for this SDK going forward + +This repository will stay in **maintenance** as described above. Feature work and new capabilities should be built against the **Content Delivery API** and your application code. + +If you need help choosing a migration path or timing, contact **[Contentstack support](https://www.contentstack.com/)** or your account team. diff --git a/README.md b/README.md index 7d783ec..7b70c4b 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,11 @@ # ![Contentstack](https://www.contentstack.com/docs/static/images/contentstack.png) +## Important: Dart SDK and pub.dev + +**We are deprecating** the **Contentstack** Dart SDK on pub.dev as the supported path for **new** development. **New Dart or Flutter projects should use the [Content Delivery API](https://www.contentstack.com/docs/developers/apis/content-delivery-api/)** directly with the HTTP client of your choice. + +**Already using this SDK?** You can keep shipping with your current dependencies and migrate when it makes sense for your app. More detail: **[DEPRECATION.md](DEPRECATION.md)**. + ## Dart SDK for Contentstack ![version](https://img.shields.io/github/v/release/contentstack/contentstack-dart)