@servicetitan/docs-anvil-uikit-contrib 25.4.0 → 25.4.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +20 -7
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -12,6 +12,8 @@ To preview changes use the local `docusaurus` project. See the `docusaurus` READ
|
|
|
12
12
|
|
|
13
13
|
Use `yalc` to preview changes within the entire ServiceTitan Engineering documentation.
|
|
14
14
|
|
|
15
|
+
### Initial setup
|
|
16
|
+
|
|
15
17
|
1. Install the `yalc` package globally
|
|
16
18
|
|
|
17
19
|
```sh
|
|
@@ -25,21 +27,21 @@ $ cd <path-to-anvil-uikit-contrib>
|
|
|
25
27
|
$ npm run build
|
|
26
28
|
```
|
|
27
29
|
|
|
28
|
-
3. Run `yalc publish` in the `docs`
|
|
30
|
+
3. Run `yalc publish` in the `packages/docs` folder to publish the package documentation locally
|
|
29
31
|
|
|
30
32
|
```sh
|
|
31
|
-
$ cd
|
|
33
|
+
$ cd ./packages/docs
|
|
32
34
|
$ yalc publish
|
|
33
35
|
```
|
|
34
36
|
|
|
35
|
-
4. Run `yalc add @servicetitan/docs-anvil-uikit-contrib` in the servicetitan
|
|
37
|
+
4. Run `yalc add @servicetitan/docs-anvil-uikit-contrib` in the `servicetitan/docs` repo to use the locally published documents
|
|
36
38
|
|
|
37
39
|
```sh
|
|
38
|
-
$ cd <path-to-servicetitan
|
|
40
|
+
$ cd <path-to-servicetitan/docs>
|
|
39
41
|
$ yalc add @servicetitan/docs-anvil-uikit-contrib
|
|
40
42
|
```
|
|
41
43
|
|
|
42
|
-
5. Update dependencies
|
|
44
|
+
5. Update dependencies
|
|
43
45
|
|
|
44
46
|
```sh
|
|
45
47
|
$ npm i
|
|
@@ -53,9 +55,20 @@ $ npm start
|
|
|
53
55
|
|
|
54
56
|
This opens the documentation in a browser window.
|
|
55
57
|
|
|
56
|
-
|
|
58
|
+
### Live updates
|
|
59
|
+
|
|
60
|
+
To see further changes without having to restart the server,
|
|
61
|
+
|
|
62
|
+
1. Run `yalc push` in the anvil-uikit-contrib `packages/docs` folder to push changes to `servicetitan/docs`
|
|
57
63
|
|
|
58
64
|
```sh
|
|
59
|
-
|
|
65
|
+
# > anvil-uikit-contrib/packages/docs
|
|
60
66
|
$ yalc push
|
|
61
67
|
```
|
|
68
|
+
|
|
69
|
+
2. Run `npm run prebuild` (or `npm run import-package-docs`) in `servicetitan/docs`
|
|
70
|
+
|
|
71
|
+
```sh
|
|
72
|
+
# > servicetitan/docs
|
|
73
|
+
$ npm run prebuild
|
|
74
|
+
```
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@servicetitan/docs-anvil-uikit-contrib",
|
|
3
|
-
"version": "25.4.
|
|
3
|
+
"version": "25.4.1",
|
|
4
4
|
"description": "",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
@@ -16,5 +16,5 @@
|
|
|
16
16
|
"cli": {
|
|
17
17
|
"webpack": false
|
|
18
18
|
},
|
|
19
|
-
"gitHead": "
|
|
19
|
+
"gitHead": "47af4bd32673af7e0292f1e55316164615135b74"
|
|
20
20
|
}
|