stackblitz / tutorialkit

TutorialKit by StackBlitz - Create interactive tutorials powered by the WebContainer API
https://tutorialkit.dev
MIT License
504 stars 48 forks source link

feat!: mark `@tutorialkit/react` component API as experimental feature #346

Closed AriPerkkio closed 1 month ago

AriPerkkio commented 1 month ago

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.

stackblitz[bot] commented 1 month ago

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.