feat!: mark @tutorialkit/react component API as experimental feature
#346
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
AriPerkkio
added
documentation
|
|
AriPerkkio
commented
Sep 24, 2024
Comment on lines
+25
to
+31
| :::note | ||
| Using `@tutorialkit/react` package directly without `@tutorialkit/astro` is **experimental** at the moment. | ||
| This package may introduce breaking changes in patch and minor version updates. Pay extra attention when updating the versions. | ||
|
|
||
| We are planning to stabilize component API of `@tutorialkit/react` in future. | ||
| ::: | ||
|
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
@tutorialkit/reactas experimental feature@tutorialkit/reactwithout TutorialKit itselfThe components of
@tutorialkit/reactare 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/reactAPI 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.