docs: add steps for contributing to docs locally (#23270)

This commit is contained in:
Michel EDIGHOFFER 2023-09-18 12:10:54 +02:00 committed by GitHub
parent ac380ad053
commit d7aa6f37af
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -131,9 +131,10 @@ git checkout -b my-new-branch
The Nuxt documentation is currently deployed within [nuxt/nuxt.com](https://github.com/nuxt/nuxt.com) as a layer. The Nuxt documentation is currently deployed within [nuxt/nuxt.com](https://github.com/nuxt/nuxt.com) as a layer.
- Run `pnpm build:stub` once in the root directory - Run `pnpm build:stub` once in the root directory
<!-- - Go into the docs directory: `cd docs` --> - Go into the `.website` directory: `cd .website`
<!-- - Install docs dependencies using `yarn install` --> - Install dependencies using `pnpm install`
<!-- - Run `yarn dev` to start docs in development mode --> <!-- TODO: make 2 previous steps transparent by running pnpm docs:dev from root directory -->
- Run `pnpm dev` to start docs in development mode
- Before opening a PR, run `pnpm lint:docs:fix` to highlight and resolve any lint issues - Before opening a PR, run `pnpm lint:docs:fix` to highlight and resolve any lint issues
::alert ::alert