Marks direct usage of @tutorialkit/react as experimental feature
This does not affect users of TutorialKit. This affects only users who are using @tutorialkit/react without TutorialKit itself
The components of @tutorialkit/react are exposed as public API but we don't have any test cases for these components. We only have e2e tests through @tutorialkit/astro. When ever we implement new features to @tutorialkit/astro, we need to pay extra attention not to introduce any new required component props, or modify any existing ones to avoid semver breaking changes. Breaking the API is too easy at the moment and not easily visible from the code.
Now that we are still in v0.x.x version, let's mark @tutorialkit/react API as experimental. This allows us to keep breaking the API when needed. Once we get more test cases and see that implementing new features doesn't require breaking the API anymore, let's remove the experimental status.
@tutorialkit/react
as experimental feature@tutorialkit/react
without TutorialKit itselfThe components of
@tutorialkit/react
are exposed as public API but we don't have any test cases for these components. We only have e2e tests through@tutorialkit/astro
. When ever we implement new features to@tutorialkit/astro
, we need to pay extra attention not to introduce any new required component props, or modify any existing ones to avoid semver breaking changes. Breaking the API is too easy at the moment and not easily visible from the code.Now that we are still in v0.x.x version, let's mark
@tutorialkit/react
API as experimental. This allows us to keep breaking the API when needed. Once we get more test cases and see that implementing new features doesn't require breaking the API anymore, let's remove the experimental status.