Rework api categories format#9160
Conversation
|
Formatted example: API categoriesiTwin.js uses API Extractor to help manage its APIs. Each API exported by a package is marked with one of four "release tags" categorizing its level of maturity.
In addition to any one of the above release tags, an API may also be tagged as:
Only "public" and "beta" APIs are included in the published documentation. An API typically starts out as "beta". It may evolve rapidly in response to feedback before stabilizing and being promoted to "public". On occasion, a "beta" API may be abandoned - not all experiments succeed. The "public API" of a package comprises the set of all APIs it contains that are marked with the "public" release tag. The package's public API enjoys stability guarantees provided by the package versioning policy. Contributors to iTwin.js should follow the provided guidelines when applying release tags to their APIs. |
Trying to make it clearer that deprecated and preview tags are to be used on top of any of the other categories.
Also Preview does not link to anything and looks weird. Not sure if we should link to something or just remove the square brackets so it looks more normal
Current docs