@servicetitan/docs-anvil-uikit-contrib

This package contains documentation for Frontend Community packages, published at https://docs.st.dev.

Preview changes in situ

Use yalc to preview changes within the entire ServiceTitan Engineering documentation.

Initial setup

1. Install the yalc package globally

$ npm i yalc -g

2. Build the anvil-uikit-contrib packages

$ cd <path-to-anvil-uikit-contrib>
$ npm run build

3. Run yalc publish in the packages/docs folder to publish the package documentation locally

$ cd ./packages/docs
$ yalc publish

4. Run yalc add @servicetitan/docs-anvil-uikit-contrib in the servicetitan/docs repo to use the locally published documents

$ cd <path-to-servicetitan/docs>
$ yalc add @servicetitan/docs-anvil-uikit-contrib

5. Update dependencies

$ npm i

6. Start Docusaurus

$ npm start

This opens the documentation in a browser window.

Live updates

To see further changes without having to restart the server,

1. Run yalc push in the anvil-uikit-contrib packages/docs folder to push changes to servicetitan/docs

# > anvil-uikit-contrib/packages/docs
$ yalc push

2. Run npm run prebuild (or npm run import-package-docs) in servicetitan/docs

# > servicetitan/docs
$ npm run prebuild