We currently do not display documentation for APIs that are in @alpha. The idea was that we wanted to test these APIs out internally (with the @internal tag being reserved for package-to-package use, not intended for any public consumption).
As long as we accurately communicate expectations to users, we should be honest and open about what features we're working on and are available. Any feedback from 1st or 3rd party users is highly valued and documenting the @alpha APIs makes them more discoverable.
We will need to update our api support policies and consider how to properly convey the unstable nature of @alpha APIs beyond a simple badge.
@khanaffan has pointed to Node's docs which use strong color codes to convey the stability of APIs.
We currently do not display documentation for APIs that are in
@alpha. The idea was that we wanted to test these APIs out internally (with the@internaltag being reserved for package-to-package use, not intended for any public consumption).As long as we accurately communicate expectations to users, we should be honest and open about what features we're working on and are available. Any feedback from 1st or 3rd party users is highly valued and documenting the
@alphaAPIs makes them more discoverable.We will need to update our api support policies and consider how to properly convey the unstable nature of
@alphaAPIs beyond a simple badge.@khanaffan has pointed to Node's docs which use strong color codes to convey the stability of APIs.