-
Notifications
You must be signed in to change notification settings - Fork 728
chore: update to docusaurus v3 #1326
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
❌ Deploy Preview for testing-library failed.
|
Thanks Tim!
AFAIR, the serious breaking change was upgrading to MDX v2, if our build passes I think we're good but maybe we can just verify it manually by running npx docusaurus-mdx-checker
.
As far as I was able to see, there are also some visual changes, if you want I can have a look at those listed here:
https://docusaurus.io/blog/preparing-your-site-for-docusaurus-v3
You're right @MatanBobi
I don't see any changes between our live version and this preview version.
@timdeschryver i saw that they've released a new RC using MDX 3 today (or maybe that was yesterday?)
Are we waiting for the official release to merge this? I haven't had the time to review it yet so just wanted to know the urgency.
It can wait @MatanBobi
Thanks, I've updated to RC 1 (latest). Would it make sense to compare against the latest version of our template too?
3.0.0 is released, I will update the PR later this week.
I can help with updating the PR, but I'd like to block it on #1339 so we don't have to manually add pnpm to the docs.
5aa61a9
to
f74b33f
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've browsed through the site and things look good :)
If it's ready in your opinion, feel free to merge this.
Thanks Tim!
Thanks @MatanBobi , I'd like to wait on @nickmccurdy 's review
Working on this a bit more by reviewing nitpicks and Docusaurus docs. Have we done any visual comparisons yet or should I try?
Working on this a bit more by reviewing nitpicks and Docusaurus docs. Have we done any visual comparisons yet or should I try?
I made a quick browse (but haven't looked at all of the pages) and AFAIR, @timdeschryver also did.
Great, thanks.
npx docusaurus-mdx-checker
seems to be ok too, though the counts are off: slorber/docusaurus-mdx-checker#1
Working on this a bit more by reviewing nitpicks and Docusaurus docs. Have we done any visual comparisons yet or should I try?
@MatanBobi and myself have done some manual tests.
I don't know if visual tests are worth the effort because we don't do anything special, we just use the default setup. That being said, ideally we have some tests so if you want please feel free and go ahead.
npx docusaurus-mdx-checker seems to be ok too, though the counts are off
AFAIK, we're not using MDX, just plain markdown. So this doesn't affect us too much.
While upgrading another docs website I noticed we can also be explicit about this, and set the parser to markdown
. https://docusaurus.io/docs/api/docusaurus-config#format
Working on this a bit more by reviewing nitpicks and Docusaurus docs. Have we done any visual comparisons yet or should I try?
@MatanBobi and myself have done some manual tests. I don't know if visual tests are worth the effort because we don't do anything special, we just use the default setup. That being said, ideally we have some tests so if you want please feel free and go ahead.
We can use visual regression tests for this. However, it requires setting up additional infrastructure, so I'd prefer to investigate after. For now we should be fine, I forgot you both tested manually.
AFAIK, we're not using MDX, just plain markdown. So this doesn't affect us too much. While upgrading another docs website I noticed we can also be explicit about this, and set the parser to
markdown
. https://docusaurus.io/docs/api/docusaurus-config#format
@timdeschryver I think we are using MDX features, I think this is an example, right?
What's the status with this PR, do we need to take further actions?
I'm still working on it, hopefully some more next week.
After updates, we can do this thing at root config ^_^
headTags: [
{
tagName: 'link',
attributes: {
rel: 'preconnect',
href: 'https://fonts.gstatic.com'
},
},
],
I wanted to see the impact of upgrading docusaurus, but everything seemed fined locally.
This is a test to verify that our pipeline still works.