Skip to content

Added deprecation notice in CHANGELOG and README. #61

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
netrajpatel merged 1 commit into from
Apr 13, 2026
Merged

Added deprecation notice in CHANGELOG and README. #61

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down
25 changes: 25 additions & 0 deletions DEPRECATION.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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)
Expand Down