@servicetitan/docs-uikit 22.11.0 → 22.13.0

package/README.md

@@ -1,48 +1,59 @@
 # `@servicetitan/docs-uikit`
 
-This package contains documentation for Frontend Platform packages that is hosted at https://docs.st.dev.
+This package contains documentation for Uikit packages, published at https://docs.st.dev.
 
 ## Preview changes locally
 
-Use the `yalc` package to preview changes before they are published:
+To preview changes use the local `docusaurus` project. See the `docusaurus` README for instructions.
+
+## Preview changes in situ
+
+Use `yalc` to preview changes within the entire ServiceTitan Engineering documentation.
 
 1. Install the `yalc` package globally
 
-```
+```sh
 $ npm i yalc -g
 ```
 
 2. Build the `uikit` packages
 
-```
+```sh
 $ cd <path-to-uikit>
 $ npm run build
 ```
 
-3. Run `yalc publish` in the `docs` package folder
+3. Run `yalc publish` in the `docs` package folder to publish the package locally
 
-```
-$ cd .\packages\docs\
+```sh
+$ cd .\packages\docs
 $ yalc publish
 ```
 
-4. Run `yalc add @servicetitan/docs-uikit` in ServiceTitan Engineering `docs` project, which will cause it to use the location version of the `@servicetitan/docs-uikit` package
+4. Run `yalc add @servicetitan/docs-uikit` in the servicetitan `docs` repo to use the locally published package
 
-```
-$ cd <path-to-your-servicetitan-docs>
+```sh
+$ cd <path-to-servicetitan-docs>
 $ yalc add @servicetitan/docs-uikit
 ```
 
-5. Update your dependencies
+5. Update dependencies and start Docusaurus
 
-```
+```sh
 $ npm i
 ```
 
-6. Start the local Docusaurus server
+6. Start Docusaurus
 
-```
+```sh
 $ npm start
 ```
 
-This opens the documentation in a browser window. Changes are reflected live without having to restart the server.
+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
+
+```sh
+$ cd <path-to-uikit>/packages/docs
+$ yalc push
+```

package/docs/startup.mdx

@@ -79,7 +79,9 @@ npx -y @servicetitan/startup@latest init
 
 ### install
 
-Installs the package dependencies.
+Installs the package dependencies. This command should be run via `npx` before the build.
+
+See [configuration example in the `init` template](https://github.com/servicetitan/uikit/blob/master/packages/startup/template/package.json)
 
 ### start
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@servicetitan/docs-uikit",
-    "version": "22.11.0",
+    "version": "22.13.0",
     "description": "",
     "repository": {
         "type": "git",
@@ -15,5 +15,6 @@
     },
     "cli": {
         "webpack": false
-    }
+    },
+    "gitHead": "0371ceba4ebc06491f4cb85fcc7ce9d4193617af"
 }