Skip to content

Commit a485c2b

Browse files
committed
Update README with upgrade warning about swizzle
1 parent 14c7631 commit a485c2b

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,9 @@ To upgrade docusaurus to a more recent version:
7272
- `package.json`
7373
- `yarn.lock`
7474

75+
> **Warning**
76+
> 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.
77+
7578
## Code of Conduct
7679

7780
In the interest of fostering an open and welcoming environment, we as

0 commit comments

Comments
 (0)