You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Please include a summary of the change. Please also include relevant motivation and context. List any dependencies that are required for this change.
6
-
7
-
Fixes # (issue)
5
+
This PR Resolves #(issue)
8
6
9
7
## Type of change
10
8
@@ -13,22 +11,16 @@ Please delete options that are not relevant.
13
11
-[ ] Bug fix (non-breaking change which fixes an issue).
14
12
-[ ] New feature (non-breaking change which adds functionality).
15
13
-[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected).
16
-
-[ ]This change requires a documentation update.
14
+
-[ ]Documentation update (if none of the other choices apply).
17
15
18
16
## How Has This Been Tested?
19
17
20
-
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
21
-
22
-
## Additional Context (Please include any Screenshots/gifs if relevant)
18
+
Please run npm run build and npm run serve to check if the changes are working as expected. Please include screenshots of the output of both the commands. Add screenshots/gif of the changes if possible.
23
19
24
-
...
25
20
26
21
## Checklist:
27
22
28
23
-[ ] My code follows the style guidelines of this project.
29
24
-[ ] I have performed a self-review of my own code.
30
-
-[ ] I have made corresponding changes to the documentation.
31
-
-[ ] I have added corresponding tests.
32
-
-[ ] Any dependent changes have been merged and published in downstream modules.
33
25
34
-
<!--- Thanks for opening this pull request! If the tests fail, please feel free to reach out to us by leaving a comment down below and we will be happy to take a look --->
26
+
<!--- Thanks for opening this pull request! If the tests fail, please feel free to reach out to us by leaving a comment down below and we will be happy to take a look --->
Copy file name to clipboardExpand all lines: README.md
+6-5Lines changed: 6 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -64,12 +64,13 @@ The Keploy documentation site uses [Docusaurus 2](https://v2.docusaurus.io/), wh
64
64
You can make changes locally without previewing them in the browser.
65
65
However, if you want to build the site and preview changes in the browser, you need to have [Docusaurus 2 dependencies](https://v2.docusaurus.io/docs/installation/#requirements) installed.
66
66
67
-
Initialize Docusaurus 2 in the repo by running [`yarn`](https://classic.yarnpkg.com/en/docs/cli/) once in the root directory of the repo.
67
+
Initialize Docusaurus 2 in the repo by running [`npm`](https://docs.npmjs.com/cli/v7/commands/npm-install) once in the root directory of the repo.
68
68
69
69
Now you can build and view the site locally:
70
70
71
71
```bash
72
-
yarn start
72
+
npm install
73
+
npm start
73
74
```
74
75
75
76
The command starts a local development server and opens a browser window.
0 commit comments