miel.truyen/nx
1
0
Fork 0
Code Issues Pull Requests Actions 5 Packages Projects Releases Wiki Activity

docs(core): update docs contributing guide (#19410)

Browse Source
This commit is contained in:
Isaac Mann 2023-10-03 10:12:52 -04:00 committed by GitHub
parent e20a3d0920
commit eb532f45e9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
CONTRIBUTING.md
View File

@ -177,6 +177,8 @@ The `docs/map.json` file is considered our source of truth for our site's struct
new page to our documentation to ensure that it is included in the documentation site. We also run automated scripts
based on this `map.json` data to safeguard against common human errors that could break our site.
When you make a change to the `map.json` file, make sure to run `pnpm documentation` to propagate your changes to the `nx-dev` application.
#### Nx-Dev Application
Our public `nx.dev` documentation site is a [Next.js](https://nextjs.org/) application, that can be found in
@ -209,10 +211,10 @@ adjusting the docs.
To run `nx-dev` locally, run the command:
```bash
npx nx serve nx-dev
npx nx serve-docs nx-dev
```
You can then access the application locally at `localhost:4200`.
You can then access the application locally at `localhost:4200`. Changes to markdown documentation files will be automatically applied to the site when you refresh the browser.
#### Troubleshooting: `JavaScript heap out of memory`