From a485c2b72b34cc57e65730242e73b1e52ba184d5 Mon Sep 17 00:00:00 2001 From: Frode Flaten <3436158+fflaten@users.noreply.github.com> Date: Fri, 5 May 2023 20:36:42 +0000 Subject: [PATCH] Update README with upgrade warning about swizzle --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index efb8f2f8..b46add26 100644 --- a/README.md +++ b/README.md @@ -72,6 +72,9 @@ To upgrade docusaurus to a more recent version: - `package.json` - `yarn.lock` +> **Warning** +> Giscus comments are implemented using a unsafe [swizzle](https://docusaurus.io/docs/swizzling#ejecting) of `DocItem/Layout` that could break in minor upgrades of Docusaurus. See [comments here](https://github.com/pester/docs/blob/main/src/theme/DocItem/Layout/index.js) for update instructions. + ## Code of Conduct In the interest of fostering an open and welcoming environment, we as