From 64c4653c3e9c074ca4984396adf1d1375d6d226b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ari=20Perkki=C3=B6?= Date: Tue, 24 Sep 2024 16:41:52 +0300 Subject: [PATCH] feat!: mark `@tutorialkit/react` direct usage as experimental feature --- .../src/content/docs/reference/react-components.mdx | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/tutorialkit.dev/src/content/docs/reference/react-components.mdx b/docs/tutorialkit.dev/src/content/docs/reference/react-components.mdx index cae59f46..8335f032 100644 --- a/docs/tutorialkit.dev/src/content/docs/reference/react-components.mdx +++ b/docs/tutorialkit.dev/src/content/docs/reference/react-components.mdx @@ -22,6 +22,13 @@ import sourceUseWebcontainer from "@components/react-examples/hooks/useWebcontai You can reuse TutorialKit's React components in your own applications. They are designed to work well with the [WebContainer API][webcontainers]. +:::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. +::: + Here's a simple editor that can be made with those components: