Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions .github/workflows/docs-auto-update.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ jobs:
node-version: 20
package-manager-cache: false
- run: corepack enable
- run: yarn --immutable
- run: yarn md-fmt
- run: pnpm i --frozen-lockfile
- run: pnpm md-fmt
# This is needed in order to have the commits signed.
- uses: actions/create-github-app-token@v2
id: generate-token
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/docs-check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,4 @@ jobs:
- uses: jdx/mise-action@v3
- run: mise run docs:format-spellcheck-dictionary-check
- run: mise run docs:lint
- run: yarn build
- run: pnpm build
4 changes: 2 additions & 2 deletions .github/workflows/docs-deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@ jobs:
node-version: 20
package-manager-cache: false
- run: corepack enable
- run: yarn --immutable
- run: yarn run build
- run: pnpm i --frozen-lockfile
- run: pnpm build

- name: Deploy
uses: cloudflare/wrangler-action@v3
Expand Down
14 changes: 7 additions & 7 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,40 +4,40 @@ This directory contains a Docusaurus documentation website for both user and dev

## Getting Started

> Note: This project uses [Yarn](https://yarnpkg.com/getting-started/install)
> Note: This project uses [pnpm](https://pnpm.io/installation)

### Installation

Install the required dependencies:

```
$ yarn
$ pnpm i
```

### Local Development

Start local development server:

```
$ yarn start
$ pnpm start
```

### Build

To compile an optimized production build:

```
$ yarn build
$ pnpm build
```

### CI Checks

These commands are recommended to run before committing code. They are run as checks in CI.

```
yarn spellcheck # Checks spelling
yarn format # Run prettier to fix formatting issues
yarn typecheck # Validate typescript files
pnpm spellcheck # Checks spelling
pnpm format # Run prettier to fix formatting issues
pnpm typecheck # Validate typescript files
```

> **How to Fix Spellcheck Errors:** You can add unknown words to `dictionary.txt`.
Expand Down
12 changes: 7 additions & 5 deletions docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
"version": "0.0.0",
"private": true,
"engines": {
"node": ">=20.0.0"
"node": ">=20",
"pnpm": ">=10"
},
"scripts": {
"docusaurus": "docusaurus",
Expand All @@ -24,17 +25,19 @@
"@docusaurus/core": "^3.9.2",
"@docusaurus/preset-classic": "^3.9.2",
"@docusaurus/theme-mermaid": "^3.9.2",
"@easyops-cn/docusaurus-search-local": "^0.54.0",
"@easyops-cn/docusaurus-search-local": "^0.54.1",
"mdx-mermaid": "^2.0.3",
"mermaid": "^11.12.2",
"prettier": "^3.8.0",
"prettier": "^3.8.1",
"prism-react-renderer": "^2.4.1",
"react": "^19.2.4",
"react-dom": "^19.2.4"
},
"devDependencies": {
"@docusaurus/mdx-loader": "^3.9.2",
"@docusaurus/module-type-aliases": "^3.9.2",
"@docusaurus/tsconfig": "^3.9.2",
"@docusaurus/types": "^3.9.2",
"spellchecker-cli": "^7.0.2",
"typescript": "^5.9.3"
},
Expand All @@ -52,6 +55,5 @@
},
"resolutions": {
"dompurify": "3.3.1"
},
"packageManager": "yarn@4.12.0"
}
}
Loading
Loading