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
Copy file name to clipboardExpand all lines: docs/02-Writing-Docs.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,15 +25,15 @@ have this comment in any part of the file:
25
25
```
26
26
27
27
### Writing JSDoc in source
28
-
Let us consider this example source file [src/utils/Metrics.js](https://github.com/phcode-dev/Phoenix/blob/main/src/utils/Metrics.js).
28
+
Let us consider this example source file [src/utils/Metrics.js](https://github.com/phcode-dev/phoenix/blob/main/src/utils/Metrics.js).
29
29
The file is created with [JSDoc](https://jsdoc.app/) compliant source code comments. Make changes to
30
30
the source code comments as required.
31
31
32
-
When you run `npm run createJSDoc` or `npm run build` the corresponding docs for the js file are automatically generated at [docs/generatedApiDocs/utils/Metrics-API.md](https://github.com/phcode-dev/Phoenix/blob/main/docs/generatedApiDocs/utils/Metrics-API.md).
32
+
When you run `npm run createJSDoc` or `npm run build` the corresponding docs for the js file are automatically generated at [docs/generatedApiDocs/utils/Metrics-API.md](https://github.com/phcode-dev/phoenix/blob/main/docs/generatedApiDocs/utils/Metrics-API.md).
33
33
34
34
The generated docs should be pushed to Phoenix repo if there are any doc changes.
35
35
Once the changes are pushed, the build system will update the docs in all
0 commit comments