Skip to content
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

docs: standardize shell commands in the docs #1470

Merged
merged 8 commits into from
Dec 12, 2023

Conversation

richardgreg
Copy link
Contributor

Removed yarn, ensured all examples have two variations and tabularized examples.

close #1459

Copy link
Member

@arboleya arboleya left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your contribution!

@richardgreg
Copy link
Contributor Author

I will make the changes and update the PR.

Is there a command that can build the doc locally?

@arboleya
Copy link
Member

arboleya commented Nov 29, 2023

You can run the dev command inside the apps/docs dir:

cd apps/docs
pnpm dev

Removed `yarn`, ensured all examples have two variations and tabularized
examples.

close FuelLabs#1459
@richardgreg richardgreg force-pushed the shell-command-standardization branch from 40f3740 to 3dca64d Compare November 30, 2023 06:40
@richardgreg richardgreg requested a review from arboleya November 30, 2023 11:07
@richardgreg
Copy link
Contributor Author

richardgreg commented Dec 4, 2023

I probably should have asked this earlier, should I also change the examples in /packages? And every other instance in the repo?

@danielbate
Copy link
Member

@richardgreg Yes please 🙏🏻 This would be beneficial since we only recently started recommending pnpm.

fuels-ts/package.json

Lines 7 to 10 in 17788fe

"engines": {
"node": "^18.14.1",
"pnpm": "^8.9.0"
},

However, please only change inside packages and leave apps as is (not including your already implemented apps/docs changes). As we may be using yarn/npm for compatibility testing there.

@richardgreg richardgreg force-pushed the shell-command-standardization branch from 09264be to bffd693 Compare December 6, 2023 15:14
@CLAassistant
Copy link

CLAassistant commented Dec 8, 2023

CLA assistant check
All committers have signed the CLA.

@arboleya arboleya added the docs Requests pertinent to documentation label Dec 8, 2023
@arboleya arboleya added this to the Salamander milestone Dec 8, 2023
@arboleya arboleya enabled auto-merge (squash) December 12, 2023 19:04
@arboleya arboleya removed this from the Salamander milestone Dec 12, 2023
@arboleya arboleya merged commit 3f0c18f into FuelLabs:master Dec 12, 2023
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Requests pertinent to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Standardize shell commands in the docs
5 participants