Documentation Tagging Feature #7585
bigtimebuddy
started this conversation in
RFC
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
The API docs are pretty extensive, but it's hard to distinguish between various APIs. I'd like to introduce new tagging and filtering functionality to the docs to help clarify context and make the docs a little more useful.
Maturity Flags
These indicate how mature the API should be considered.
@stable
- considered reliable and unlikely to change between major versions@experimental
- proceed with caution, will maybe will change later@deprecated
- same as current usage, don't use, will get eliminated in next major versionAudience Flags
These indicate usage for a particular audience.
@essential
- beginners, first-learn APIs@advanced
- typical for plugin developers, these usually require some advanced understand of pixi to use@internal
- internal use only, these are required in some cases to communicate between pixi systemsBeta Was this translation helpful? Give feedback.
All reactions