From dab7b8e89ed72076ee5135571095adea3bf130e6 Mon Sep 17 00:00:00 2001 From: Victor Fernandez de Alba Date: Wed, 16 Oct 2024 09:13:59 +0200 Subject: [PATCH] Better admonitions format for experimental notices. --- apps/nextjs/README.md | 9 ++++----- apps/remix/README.md | 9 ++++----- apps/vite-ssr/README.md | 9 ++++----- apps/vite/README.md | 5 +++++ packages/blocks/README.md | 9 ++++----- packages/helpers/README.md | 9 ++++----- packages/providers/README.md | 9 ++++----- packages/slots/README.md | 9 ++++----- packages/tsconfig/README.md | 9 ++++----- 9 files changed, 37 insertions(+), 40 deletions(-) diff --git a/apps/nextjs/README.md b/apps/nextjs/README.md index 2a0f94db03..c04dca61ad 100644 --- a/apps/nextjs/README.md +++ b/apps/nextjs/README.md @@ -2,11 +2,10 @@ This is a proof of concept of a [Next.js](https://nextjs.org) app, using the app router and the `@plone/client` and `@plone/components` library. This is intended to serve as both a playground for the development of both packages and as demo of Plone using Next.js. -## EXPERIMENTAL - -This package or app is experimental. -The community offers no support whatsoever for it. -Breaking changes may occur without notice. +> [!WARNING] +> This package or app is experimental. +> The community offers no support whatsoever for it. +> Breaking changes may occur without notice. ## Development diff --git a/apps/remix/README.md b/apps/remix/README.md index 9470de487b..f9d62166c0 100644 --- a/apps/remix/README.md +++ b/apps/remix/README.md @@ -3,11 +3,10 @@ This is a proof of concept of a [Remix](https://remix.run) app, using the `@plone/client` and `@plone/components` libraries. This is intended to serve as both a playground for the development of both packages and as a demo of Plone using Remix. -## EXPERIMENTAL - -This package or app is experimental. -The community offers no support whatsoever for it. -Breaking changes may occur without notice. +> [!WARNING] +> This package or app is experimental. +> The community offers no support whatsoever for it. +> Breaking changes may occur without notice. ## Development diff --git a/apps/vite-ssr/README.md b/apps/vite-ssr/README.md index 953ea4eb82..f672cf5770 100644 --- a/apps/vite-ssr/README.md +++ b/apps/vite-ssr/README.md @@ -5,8 +5,7 @@ This is intended to serve as both a playground for the development of both packa It also uses [TanStack Router](https://tanstack.com/router/latest/docs/framework/react/overview) for its routing library. -## EXPERIMENTAL - -This package or app is experimental. -The community offers no support whatsoever for it. -Breaking changes may occur without notice. +> [!WARNING] +> This package or app is experimental. +> The community offers no support whatsoever for it. +> Breaking changes may occur without notice. diff --git a/apps/vite/README.md b/apps/vite/README.md index 97978cb92e..3e508c1a97 100644 --- a/apps/vite/README.md +++ b/apps/vite/README.md @@ -4,3 +4,8 @@ This is a proof of concept of a [Vite](https://vite.dev/) build, using `@plone/c This is intended to serve as both a playground for the development of both packages and as a demo of Plone using Vite. It also uses [TanStack Router](https://tanstack.com/router/latest/docs/framework/react/overview) for its routing library. + +> [!WARNING] +> This package or app is experimental. +> The community offers no support whatsoever for it. +> Breaking changes may occur without notice. diff --git a/packages/blocks/README.md b/packages/blocks/README.md index 4f6e0c255c..f5fe18bc4f 100644 --- a/packages/blocks/README.md +++ b/packages/blocks/README.md @@ -6,8 +6,7 @@ It's one of the Plone frontend strategic packages and part of the headless CMS s `@plone/blocks` is not part of Volto, and thus, is not used by it. -## EXPERIMENTAL - -This package or app is experimental. -The community offers no support whatsoever for it. -Breaking changes may occur without notice. +> [!WARNING] +> This package or app is experimental. +> The community offers no support whatsoever for it. +> Breaking changes may occur without notice. diff --git a/packages/helpers/README.md b/packages/helpers/README.md index 99aa0f2eab..f9c90bc51b 100644 --- a/packages/helpers/README.md +++ b/packages/helpers/README.md @@ -1,7 +1,6 @@ # @plone/helpers -## EXPERIMENTAL - -This package or app is experimental. -The community offers no support whatsoever for it. -Breaking changes may occur without notice. +> [!WARNING] +> This package or app is experimental. +> The community offers no support whatsoever for it. +> Breaking changes may occur without notice. diff --git a/packages/providers/README.md b/packages/providers/README.md index cd4702ba6d..8ba3d6aaf4 100644 --- a/packages/providers/README.md +++ b/packages/providers/README.md @@ -2,8 +2,7 @@ This package contains utility providers for Plone React components. -## EXPERIMENTAL - -This package or app is experimental. -The community offers no support whatsoever for it. -Breaking changes may occur without notice. +> [!WARNING] +> This package or app is experimental. +> The community offers no support whatsoever for it. +> Breaking changes may occur without notice. diff --git a/packages/slots/README.md b/packages/slots/README.md index 9f57a110d9..c77e2bb2de 100644 --- a/packages/slots/README.md +++ b/packages/slots/README.md @@ -2,8 +2,7 @@ This package contains the default blocks provided by Plone. -## EXPERIMENTAL - -This package or app is experimental. -The community offers no support whatsoever for it. -Breaking changes may occur without notice. +> [!WARNING] +> This package or app is experimental. +> The community offers no support whatsoever for it. +> Breaking changes may occur without notice. diff --git a/packages/tsconfig/README.md b/packages/tsconfig/README.md index ac5537d392..840f722880 100644 --- a/packages/tsconfig/README.md +++ b/packages/tsconfig/README.md @@ -28,8 +28,7 @@ In `package.json`: } ``` -## EXPERIMENTAL - -This package or app is experimental. -The community offers no support whatsoever for it. -Breaking changes may occur without notice. +> [!WARNING] +> This package or app is experimental. +> The community offers no support whatsoever for it. +> Breaking changes may occur without notice.