Skip to content

Commit 9163a1b

Browse files
authored
Update README.md
1 parent 510f0ee commit 9163a1b

File tree

1 file changed

+25
-3
lines changed

1 file changed

+25
-3
lines changed

README.md

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,24 +47,46 @@ When you submit a PR in GitHub, Netlify builds a preview automatically. However,
4747
- Node.js version 18 or higher
4848
- npm (comes bundled with Node.js)
4949

50-
### Create a Local Development Server and WYSIWYG Preview
50+
### Start the local dev server with `npm start`
5151

5252
1. Install dependencies using npm:
5353

5454
```bash
5555
npm install
5656
```
5757

58-
2. Run the following command to start a local development server and open up a browser window:
58+
2. Start a local development server in a browser window:
5959

6060
```bash
6161
npm start
6262
```
6363

64-
Most changes are reflected live without having to restart the server. This preview shows the formatting and styles as they would render on the live site (what-you-see-is-what-you-get or WYSIWYG).
64+
Most changes are reflected live without having to restart the server (changes to the sidebar file typically require restarting the dev server). This preview shows the formatting and styles as they would render on the live site.
6565

6666
If you encounter any build errors, they will appear in the terminal and often indicate issues like broken links or formatting problems in the content.
6767

68+
## Build and test locally with `npm run build` and `npm run serve`
69+
70+
Before pushing changes to the remote repository, build and serve the site locally to check for errors, including broken links.
71+
72+
1. Install dependencies using npm:
73+
74+
```bash
75+
npm install
76+
```
77+
1. Build the static site files:
78+
79+
```bash
80+
npm run build
81+
```
82+
Any broken links and anchor links are listed in the output.
83+
84+
1. Serve the `build` directory locally to test:
85+
86+
```bash
87+
npm run serve
88+
```
89+
6890
## Folder Structure and TOC
6991

7092
The folder structure is broken into several high-level categories under the main `docs` folder: vendor, enterprise, reference, release notes.

0 commit comments

Comments
 (0)