Skip to content

chore: remove yarn usage from documentation #5555

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.

Sign up for GitHub

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

Merged
alexhancock merged 2 commits into from
Nov 3, 2025
Merged

chore: remove yarn usage from documentation #5555

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
04f80e2
chore: remove yarn usage from documentation
alexhancock Nov 3, 2025
5aa69eb
chore: upgrade docusaurus packages
alexhancock Nov 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions documentation/.gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,3 @@
.env.production.local

npm-debug.log*
yarn-debug.log*
yarn-error.log*
10 changes: 5 additions & 5 deletions documentation/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,21 +5,21 @@ This website is built using [Docusaurus](https://docusaurus.io/), a modern stati
### Installation

```
$ yarn
$ npm i
Copy link

Copilot AI Nov 3, 2025

Choose a reason for hiding this comment

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

[nitpick] Use 'npm install' instead of 'npm i' for consistency with the other npm commands that use the full form ('npm run start', 'npm run build', etc.). While 'npm i' is a valid shorthand, using the full command improves clarity and consistency in documentation.

Suggested change
$ npm i
$ npm install

Copilot uses AI. Check for mistakes.
```

### Local Development

```
$ yarn start
$ npm run start
```

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

### Build

```
$ yarn build
$ npm run build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.
Expand All @@ -29,13 +29,13 @@ This command generates static content into the `build` directory and can be serv
Using SSH:

```
$ USE_SSH=true yarn deploy
$ USE_SSH=true npm run deploy
```

Not using SSH:

```
$ GIT_USER=<Your GitHub username> yarn deploy
$ GIT_USER=<Your GitHub username> npm run deploy
```

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
Expand Down
Loading