Update README with upgrade warning about swizzle

pester · May 5, 2023 · a485c2b · a485c2b
1 parent 14c7631
commit a485c2b
Showing 1 changed file with 3 additions and 0 deletions.
diff --git 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