chore(docs): Bump docusaurus to 3 and update deps #2109
Conversation
caksoylar
force-pushed
the
docs/docusaurus-3-prep
branch
from
85d5077 to
e52baf0
Compare
|
This is ready for review, but both Edit: I did resolve the issues, but perhaps not in the most ideal way. Please feel free to point out better solutions, especially for 4fc2022 and 41da0db. |
caksoylar
force-pushed
the
docs/docusaurus-3-prep
branch
from
58577d9 to
4ccd370
Compare
Following https://docusaurus.io/docs/migration/v3#upgrading-dependencies and `npm update`
Also applies prettier changes in touched files due to precommit
Some links ended up broken after docusaurus 3 upgrade, especially if they are the second on the same line and have anchors. Likely due to facebook/docusaurus#9518
eslint-plugin-react is emitting a lot of react/no-unescaped-entities errors in mdx files, primarily due to apostrophes. It seems not ideal to have to escape every apostrophe in all mdx text, so this commit disables the check. There might be a better way to handle this issue, but I am not aware of one right now.
Remove unused components, and disable proptype checking for children in OsTabs custom component since I can't figure out a way to assign propTypes to it in an mdx file.
caksoylar
force-pushed
the
docs/docusaurus-3-prep
branch
from
41da0db to
fe2f4db
Compare
Need to make prettier ignore these, because otherwise it splits them to separate lines and reverts the whole change
caksoylar
force-pushed
the
docs/docusaurus-3-prep
branch
from
9ddf234 to
33c6a37
Compare
|
I compared current and PR deploy results side-by-side for most of the pages -- they were all good except for the one issue solved by 33c6a37. I first tried converting those headers to regular markdown headers but that broke the TOC. Looks like facebook/docusaurus#9684 might make creating our own |
|
@caksoylar All seems reasonable to me, and some pragmatic fixes for the couple sticky issues. No concerns here. |
|
@petejohanson Thanks! If you are happy with it, do you mind giving a formal review? I can't approve the PR myself. |
This PR updates docusaurus to version 3, while also updating other dependencies to latest where appropriate, following https://docusaurus.io/docs/migration/v3. I think it should resolve the 4 dependabot alerts as well.
When I tried this before I had run into some issues, related to mdx upgrade from v1 to v3. But only one page turned out to be affected so that was easy too fix in d070744.
The
refactorcommits are updating things under the "Optional Changes" header in the migration guide so while they aren't strictly necessary now, they might be issues later on. I also snuck in a bug fix at 8295d76 since I was touching that line in the following commit.This still needs extensive inspection to make sure nothing broke. (The migration guide recommends visual regression tests which is something we might want to invest into at some point, but it didn't seem worth it at this point to me.)