-
Notifications
You must be signed in to change notification settings - Fork 77
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
fix: made necessary changes to docusaurus #123
Conversation
@keshakaneria & @codesankalp could u'll pls review this PR |
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.
Looks good 🎉
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 think adding a line for yarn also, will be a good option.
docs/README.md
Outdated
@@ -24,6 +24,8 @@ yarn build | |||
|
|||
This command generates static content into the `build` directory and can be served using any static contents hosting service. | |||
|
|||
**Note**: You can use `npm run serve` to test your build locally. |
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.
**Note**: You can use `npm run serve` to test your build locally. | |
**Note**: You can use `yarn serve` to test your build locally. |
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.
@codesankalp could you pls explain why I should replace npm run serve
with yarn serve
? I don't see much difference in it, but I guess yarn
is much faster than npm
.
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.
@ashwinijha6 You have added the same note line twice. As the first few lines of the README include yarn start
, yarn build
etc.. then according to the flow there should be yarn serve
for testing the build locally.
I think it is a valid reason.
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.
Yes that was on purpose @codesankalp. I can do one thing that is change the command after yarn build
to yarn serve
& let the second command after npm run build
be as it is OR remove the second command. What do you think?
@keshakaneria & @codesankalp just I have made the changes required |
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.
@ashwinijha6 QA checks are failing please run the linter and formatter as mentioned in the readme.
Hey @Amulya-coder I did this error while running |
@ashwinijha6 Delete your node_modules and package-lock.json. |
Ok I'll try that @codesankalp |
Will close this due to lack of update. cc @codesankalp |
Description
Made necessary changes to docusaurus :
npm run serve
wherever required in README.md in docs/Fixes #115
Type of Change:
Code/Quality Assurance Only
How Has This Been Tested?
Checklist:
Code/Quality Assurance Only