-
Notifications
You must be signed in to change notification settings - Fork 163
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
feat: Update Docusaurus from v2 to v3 #690
feat: Update Docusaurus from v2 to v3 #690
Conversation
Our Pull Request Approval ProcessWe have these basic policies to make the approval process smoother for our volunteer team. Testing Your CodePlease make sure your code passes all tests and there are no merge conflicts. The process helps maintain accurate and well-formatted documentation and is a prerequisite for getting your PR approved. Assigned reviewers regularly review the PR queue and tend to focus on PRs that are passing. ReviewersWhen your PR has been assigned reviewers contact them to get your code reviewed and approved via:
Reviewing Your CodeYour reviewer(s) will have the following roles:
CONTRIBUTING.mdRead our CONTRIBUTING.md file. Most importantly:
Other
|
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.
Congratulations on making your first PR! 🎊 If you haven't already, check out our Contributing Guidelines and PR Reporting Guidelines to ensure that you are following our guidelines for contributing and creating PR.
Hi @palisadoes, |
These files must be excluded from the upgrade because:
Please fix.
|
I just read the documentation and realized that the escaping of the characters in the 300+ files may be necessary. Please verify whether the files rendered in your PR look the same as the rendering on the site. This is important to know with and without the mdx3 conversion so that we can alter our automated documentation workflows. @tasneemkoushar, @anwersayeed FYI upgrading to Docusaurus v3 may cause issues with our workflows. This PR with the conversions seems to be escaping some javacript and HTML tags. Details here: |
Please merge the latest |
Thanks, I was able to reproduce the issue on my local. |
Please take the necessary steps to rectify this |
@Nitya-Pasrija can you once check this PR, if the changes are breaking any of the workflow. |
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 am seeing major changes in the yarn.lock file. Please do not make any such changes here as it can break the application flow and do look into it that you have followed all the correct steps while cloning the repository.
@Nitya-Pasrija The docusaurus upgrade process requires extensive package updates to It'll be important for you to review that page to see how the new |
We should merge this PR. It's been too long @anwersayeed @tasneemkoushar how will the new version impact our automated workouts from dart docs, TS docs and graphql explorer I want to make sure we don't have any additional documentation update issues because of this |
What kind of change does this PR introduce?
feature
Issue Number:
Fixes #685
Did you add tests for your changes?
No
Snapshots/Videos:
If relevant, did you update the documentation?
Summary
Update Docusaurus from v2 to v3
Does this PR introduce a breaking change?
Other information
Have you read the contributing guide?
Yes