@servicetitan/docs-uikit 22.14.0 → 22.16.0

package/README.md

@@ -10,6 +10,8 @@ To preview changes use the local `docusaurus` project. See the `docusaurus` READ
 
 Use `yalc` to preview changes within the entire ServiceTitan Engineering documentation.
 
+### Initial setup
+
 1. Install the `yalc` package globally
 
 ```sh
@@ -23,21 +25,21 @@ $ cd <path-to-uikit>
 $ npm run build
 ```
 
-3. Run `yalc publish` in the `docs` package folder to publish the package locally
+3. Run `yalc publish` in the `packages/docs` folder to publish the package documentation locally
 
 ```sh
-$ cd .\packages\docs
+$ cd ./packages/docs
 $ yalc publish
 ```
 
-4. Run `yalc add @servicetitan/docs-uikit` in the servicetitan `docs` repo to use the locally published package
+4. Run `yalc add @servicetitan/docs-uikit` in the `servicetitan/docs` repo to use the locally published documents
 
 ```sh
-$ cd <path-to-servicetitan-docs>
+$ cd <path-to-servicetitan/docs>
 $ yalc add @servicetitan/docs-uikit
 ```
 
-5. Update dependencies and start Docusaurus
+5. Update dependencies
 
 ```sh
 $ npm i
@@ -51,9 +53,20 @@ $ npm start
 
 This opens the documentation in a browser window.
 
-To see further changes without having to restart the server, run `yalc push` in the Uikit `docs` package folder
+### Live updates
+
+To see further changes without having to restart the server,
+
+1. Run `yalc push` in the uikit `packages/docs` folder to push changes to `servicetitan/docs`
 
 ```sh
-$ cd <path-to-uikit>/packages/docs
+# > uikit/packages/docs
 $ yalc push
 ```
+
+2. Run `npm run prebuild` (or `npm run import-package-docs`) in `servicetitan/docs`
+
+```sh
+# > servicetitan/docs
+$ npm run prebuild
+```

package/docs/lazy-module.mdx

@@ -32,7 +32,7 @@ export const DispatchModule: React.FC = () => <LazyDispatch />;
 
 ### lazyModule
 
-`lazyModule` accepts module loader function and returns React component that retrieves module from a remote host during the first render. Additionally `lazyModule` creates an [error boundary](/docs/frontend/error-boundary) around your module to catch and log runtime errors.
+`lazyModule` accepts module loader function and returns React component that retrieves module from a remote host during the first render. Additionally `lazyModule` creates an [error boundary](./error-boundary) around your module to catch and log runtime errors.
 
 #### Options
 

package/docs/startup.mdx

@@ -6,6 +6,9 @@ import Admonition from '@theme/Admonition';
 import { VersionHistory, Changes } from '@site/src/components/version-history';
 
 <VersionHistory>
+    <Changes forVersion="v22.15.0">
+        Runs all commands with 8GB of memory by default.
+    </Changes>
     <Changes forVersion="v22.11.0">
         Added <code>install</code> command that replaces legacy bootstrap.js
         and changed <code>init</code> template to use it.
@@ -229,6 +232,29 @@ Sometimes you may need to change the configuration of project-wide tools, e.g.,
 }
 ```
 
+#### NODE_OPTIONS
+
+To set or override Node options for startup commands, add **NODE_OPTIONS** to the `cli` node in the root `package.json`. Note, startup already runs all commands with `--max_old_space_size=8192` by default.
+
+```json title="package.json"
+{
+    ...
+    "cli": {
+        // NODE_OPTIONS for all commands. E.g.,
+        "NODE_OPTIONS": [
+            "--max_old_space_size=4096"
+        ],
+        "lint": {
+            // NODE_OPTIONS for lint command only
+        },
+        "test": {
+            // NODE_OPTIONS for test command only
+        }
+    }
+    ...
+}
+```
+
 ### Package
 
 #### `package.json` Configuration

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@servicetitan/docs-uikit",
-    "version": "22.14.0",
+    "version": "22.16.0",
     "description": "",
     "repository": {
         "type": "git",
@@ -16,5 +16,5 @@
     "cli": {
         "webpack": false
     },
-    "gitHead": "e0064d9f47c180d6b128f1b19f92c5f46d4e0320"
+    "gitHead": "79adb1a1ec5d89601541349b01201a16bc2e2db9"
 }