docs(develop-docs): Add SDK deprecation playbook#17137
Merged
christophaigner merged 5 commits intomasterfrom Mar 31, 2026
Merged
docs(develop-docs): Add SDK deprecation playbook#17137christophaigner merged 5 commits intomasterfrom
christophaigner merged 5 commits intomasterfrom
Conversation
Add a new playbook covering the full lifecycle of deprecating an entire SDK, from impact analysis through repo archival and post-EOL documentation cleanup. Derived from the Cordova and Xamarin deprecation processes. Update api-architecture standard to link to the new playbook and add cross-links from breaking-changes, dropping-platform-support, and aligning-cross-sdk-changes playbooks. Co-Authored-By: Claude <noreply@anthropic.com> Made-with: Cursor
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Fix incorrect anchor links for api-architecture and coordination-maintenance standards. Shorten package registry deprecation section by removing per-registry examples. Remove redundant GitHub topic tag recommendation from archive step. Co-Authored-By: Claude <noreply@anthropic.com> Made-with: Cursor
Mention sentry-cordova and sentry-xamarin as real-world examples of the deprecation playbook in the related resources section. Co-Authored-By: Claude <noreply@anthropic.com> Made-with: Cursor
coolguyzone
reviewed
Mar 30, 2026
|
|
||
| Archive the repository to make it read-only. Update the repo description to reflect the deprecation. | ||
|
|
||
| #### 12. Notify internal stakeholders |
Contributor
There was a problem hiding this comment.
Is there a resource to help devs identify who all the stakeholders are before deprecation?
coolguyzone
approved these changes
Mar 30, 2026
Contributor
coolguyzone
left a comment
coolguyzone
left a comment
There was a problem hiding this comment.
Process looks good, thanks for adding!
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
DESCRIBE YOUR PR
Add a new "Deprecating an SDK" playbook to the SDK Lifecycle section of develop-docs. This covers the full lifecycle of deprecating an entire SDK — from impact analysis through repo archival and post-EOL documentation cleanup.
The playbook is organized into 3 phases with 13 steps:
Derived from real-world Cordova and Xamarin deprecation processes, incorporating lessons learned from both.
Also updates 5 existing pages with cross-links:
api-architecture.mdx— Links the existing one-liner about SDK deprecation to the new playbooksdk-lifecycle/index.mdx— Updated descriptionbreaking-changes.mdx,dropping-platform-support.mdx,aligning-cross-sdk-changes.mdx— Added to Related resourcesNote: Some files have whitespace-only changes (blank lines added before bullet lists). These are Prettier auto-formatting corrections applied when the files were edited — not manual changes.
IS YOUR CHANGE URGENT?
PRE-MERGE CHECKLIST