From 6cbf25f04a275cb68cddae4846d46fb66824f349 Mon Sep 17 00:00:00 2001 From: Peter Johanson Date: Thu, 10 Oct 2024 15:35:10 -0600 Subject: [PATCH] docs: Update Studio status warnings to beta. Co-authored-by: Nicolas Munnich <98408764+Nick-Munnich@users.noreply.github.com> --- docs/docs/config/studio.md | 4 ++-- .../development/hardware-integration/physical-layouts.md | 4 ++-- docs/docs/development/studio-rpc-protocol.md | 4 ++-- docs/docs/features/studio.md | 4 ++-- docs/docs/keymaps/behaviors/studio-unlock.md | 6 ++++-- 5 files changed, 12 insertions(+), 10 deletions(-) diff --git a/docs/docs/config/studio.md b/docs/docs/config/studio.md index ddfb25df2..a361cfcd6 100644 --- a/docs/docs/config/studio.md +++ b/docs/docs/config/studio.md @@ -3,9 +3,9 @@ title: ZMK Studio Configuration sidebar_label: ZMK Studio --- -:::warning[Alpha Feature] +:::warning[Beta Feature] -ZMK Studio is still in active development and the below information is for development purposes only. For up to date information, join the [ZMK Discord](https://zmk.dev/community/discord/invite) server and discuss in `#studio-development`. +ZMK Studio is in beta. Although every effort has been made to provide a stable experience, you may still encounter issues during use. Please report any issues to [GitHub Issues](https://github.com/zmkfirmware/zmk-studio/issues). ::: diff --git a/docs/docs/development/hardware-integration/physical-layouts.md b/docs/docs/development/hardware-integration/physical-layouts.md index 873bc714a..4dd58e8db 100644 --- a/docs/docs/development/hardware-integration/physical-layouts.md +++ b/docs/docs/development/hardware-integration/physical-layouts.md @@ -29,9 +29,9 @@ It is given a name, a matrix transform, and a kscan. If all of your physical lay ## (Optional) Keys Property -:::warning[Alpha Feature] +:::warning[Beta Feature] -[ZMK Studio](../../features/studio.md) support is in alpha. Although best efforts are being made, backwards compatibility during active development is not guaranteed. +ZMK Studio is in beta. Although every effort has been made to provide a stable experience, you may still encounter issues during use. Please report any issues to [GitHub Issues](https://github.com/zmkfirmware/zmk-studio/issues). ::: diff --git a/docs/docs/development/studio-rpc-protocol.md b/docs/docs/development/studio-rpc-protocol.md index 5cfafbba7..8054e3cdf 100644 --- a/docs/docs/development/studio-rpc-protocol.md +++ b/docs/docs/development/studio-rpc-protocol.md @@ -2,9 +2,9 @@ title: ZMK Studio RPC Protocol --- -:::warning[Alpha Feature] +:::warning[Beta Feature] -ZMK Studio is still in active development, and the below information is for development purposes only. For up to date information, join the [ZMK Discord](https://zmk.dev/community/discord/invite) server and discuss in `#studio-development`. +ZMK Studio is in beta. Although every effort has been made to provide a stable experience, you may still encounter issues during use. Please report any issues to [GitHub Issues](https://github.com/zmkfirmware/zmk-studio/issues). ::: diff --git a/docs/docs/features/studio.md b/docs/docs/features/studio.md index 6e209a871..5b17ec013 100644 --- a/docs/docs/features/studio.md +++ b/docs/docs/features/studio.md @@ -2,9 +2,9 @@ title: ZMK Studio --- -:::warning[Alpha Feature] +:::warning[Beta Feature] -ZMK Studio support is in alpha. Although best efforts are being made, keeping compatibility during active development is not guaranteed. +ZMK Studio is in beta. Although every effort has been made to provide a stable experience, you may still encounter issues during use. Please report any issues to [GitHub Issues](https://github.com/zmkfirmware/zmk-studio/issues). ::: diff --git a/docs/docs/keymaps/behaviors/studio-unlock.md b/docs/docs/keymaps/behaviors/studio-unlock.md index d6e87b835..8871e91d3 100644 --- a/docs/docs/keymaps/behaviors/studio-unlock.md +++ b/docs/docs/keymaps/behaviors/studio-unlock.md @@ -3,8 +3,10 @@ title: ZMK Studio Unlock Behavior sidebar_label: ZMK Studio Unlock --- -:::warning -ZMK Studio is still in active development. This behavior is documented in preparation for its general availability. +:::warning[Beta Feature] + +ZMK Studio is in beta. Although every effort has been made to provide a stable experience, you may still encounter issues during use. Please report any issues to [GitHub Issues](https://github.com/zmkfirmware/zmk-studio/issues). + ::: ## Summary