docs icon indicating copy to clipboard operation
docs copied to clipboard

upgrading Docusaurus to v3

Open Aditya-eddy opened this issue 10 months ago • 8 comments

Pull Request Template

Description

fixes #1833 We should upgrade to v3 so that we increase the browsers support.

Fixes # (issue)

Type of change

Please delete options that are not relevant.

  • [ ] Bug fix (non-breaking change which fixes an issue).
  • [ ] New feature (non-breaking change which adds functionality).
  • [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected).
  • [ ] This change requires a documentation update.

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

Additional Context (Please include any Screenshots/gifs if relevant)

...

Checklist:

  • [ ] My code follows the style guidelines of this project.
  • [ ] I have performed a self-review of my own code.
  • [ ] I have made corresponding changes to the documentation.
  • [ ] I have added corresponding tests.
  • [ ] Any dependent changes have been merged and published in downstream modules.

Aditya-eddy avatar Apr 16 '24 03:04 Aditya-eddy

Hey @Aditya-eddy ,Please mention the issue number for discussion. @Sonichigo Please review.

re-Tick avatar Apr 16 '24 10:04 re-Tick

Hey @re-Tick I just created the pr and pushed it. Have not created an issue for it should I?

Aditya-eddy avatar Apr 16 '24 10:04 Aditya-eddy

Hey @re-Tick I just created the pr and pushed it. Have not created an issue for it should I?

It will be good to mention the issue.

re-Tick avatar Apr 17 '24 15:04 re-Tick

Hey @Aditya-eddy, there is an error while starting with yarn start && yarn build

image

With last commit as well the deploy check is failing :- https://github.com/keploy/docs/actions/runs/8749516911/job/24011321177?pr=374

Sonichigo avatar Apr 22 '24 07:04 Sonichigo

Hey @Aditya-eddy, there is an error while starting with yarn start && yarn build With last commit as well the deploy check is failing :- https://github.com/keploy/docs/actions/runs/8749516911/job/24011321177?pr=374

Hey @Sonichigo actually the docusaurus uses nodejs>=18, but in the github workflow file it was downloading the 16 some version. I have corrected the version to 18.0.0 nodejs. I think the workflow went smoothly this time. But please do check and give feedback on it. Thanks!!

Aditya-eddy avatar Apr 22 '24 11:04 Aditya-eddy

Hey @Sonichigo I have resolved all the errors only the pet-clinic error is remaining because in there we have used h1 anchors manually whiich docusaurus does not allow hence shows. Broken-Links Reference here. Please give you feedback on this. Thanks!!

Aditya-eddy avatar Apr 27 '24 17:04 Aditya-eddy

Hey @Sonichigo I have pushed the updated changes!

Aditya-eddy avatar Apr 30 '24 13:04 Aditya-eddy

Hey @nehagup i have swizzled heading component and made the h1 tags have anchors too. By default they will have id as heading but we can set them explicitly by #heading {#id}. Please give feedback on this.

Aditya-eddy avatar May 03 '24 02:05 Aditya-eddy