doc: add legacy status to stability index

Signed-off-by: James M Snell <jasnell@gmail.com>
jasnell · Mar 19, 2021 · f4d3377 · f4d3377
1 parent 65e8864
commit f4d3377
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/doc/api/documentation.md b/doc/api/documentation.md
@@ -37,6 +37,12 @@ The stability indices are as follows:
 > Stability: 2 - Stable. Compatibility with the npm ecosystem is a high
 > priority.
 
+<!-- separator -->
+
+> Stability: 3 - Legacy. The feature is no longer recommended for use. While it
+likely will not be removed, and is still covered by semantic-versioning
+guarantees, use of the feature should be avoided.
+
 Use caution when making use of Experimental features, particularly within
 modules. Users may not be aware that experimental features are being used.
 Bugs or behavior changes may surprise users when Experimental API