-
Type:
Improvement
-
Resolution: Fixed
-
Priority:
Unknown
-
Affects Version/s: None
-
Component/s: None
-
None
-
Go Drivers
-
Not Needed
-
Context
The main way we currently notify users that the x/ packages are unstable is using the README in the x/ directory. However, that's easy to miss for many users. Considering the negative impact that breaking changes can have, we should make that warning more obvious to users who only interact with the Go documentation, either through pkg.go.dev or an IDE integration.
Definition of done
- Add documentation to all packages in the x/ directory that warns IN BOLD CAPS that the package is experimental and is subject to breaking changes or removal without notice.