Deprecation and Migration Policy
How XYO documentation marks deprecated libraries and guides readers to supported replacements.
When a library is deprecated
Remove it from new tutorials and cookbook recipes.
Add a warning to any page that must remain for existing users.
Name the supported public npm replacement.
Explain the smallest safe migration path.
State the last verified version and verification date.
Remove the deprecated page after the announced support window.
Public-surface rule
Documentation may describe a package only when it is publicly downloadable from npm and the referenced symbol is part of its published exports map. A public package does not make its source repository public; do not link to source unless repository visibility has been independently verified.
CLI packages, private repositories, internal services, unpublished APIs, deep imports outside the exports map, and private application behavior are excluded from developer documentation.
Migration-page template
Every migration page should answer:
What changed?
Who is affected?
Which public package and version replaces the old surface?
What code or configuration must change?
How can the reader verify the migration?
When does support for the old surface end?
Last updated