diff --git a/README.md b/README.md index a3d96edd2a..e24051e104 100644 --- a/README.md +++ b/README.md @@ -76,13 +76,14 @@ pnpm i ### Local Development -The Rafiki local environment is the best way to explore Rafiki locally. The [localenv](localenv) directory contains instructions for setting up a local playground. +The Rafiki local environment is the best way to explore Rafiki locally. The [localenv](localenv) directory contains instructions for setting up a local playground. Please refer to the README for each individual package for more details. ### Useful commands ```sh # build all the packages in the repo: pnpm -r build + # build specific package (e.g. backend): pnpm --filter backend build diff --git a/packages/auth/package.json b/packages/auth/package.json index 870929f36c..a2d9cb9741 100644 --- a/packages/auth/package.json +++ b/packages/auth/package.json @@ -42,7 +42,7 @@ "objection-db-errors": "^1.1.2", "pg": "^8.11.3", "pino": "^8.16.1", - "token-introspection": "workspace:../token-introspection", + "token-introspection": "workspace:*", "uuid": "^9.0.1" }, "devDependencies": { diff --git a/packages/backend/package.json b/packages/backend/package.json index a31ccda914..f011349422 100644 --- a/packages/backend/package.json +++ b/packages/backend/package.json @@ -83,7 +83,7 @@ "pino": "^8.16.1", "raw-body": "^2.5.2", "tigerbeetle-node": "^0.13.57", - "token-introspection": "workspace:../token-introspection", + "token-introspection": "workspace:*", "uuid": "^9.0.1" } } diff --git a/packages/documentation/README.md b/packages/documentation/README.md index 16123e5279..e0ff5e2fd5 100644 --- a/packages/documentation/README.md +++ b/packages/documentation/README.md @@ -14,6 +14,12 @@ This website is built with [Starlight](https://starlight.astro.build/), a docume $ pnpm i ``` +- In order to support Mermaid syntax in markdown, we are relying on the [rehype-mermaid](https://github.com/remcohaszing/rehype-mermaid) plugin. This plugin has an unfortunate dependency on [Playwright](https://playwright.dev/). + +```sh +$ pnpm dlx playwright install chromium +``` + - Run the dev server from the /packages/documentation folder: ```sh @@ -25,7 +31,7 @@ This command starts a local development server and opens up a browser window. Mo - Build the site, again, this must be run from the /packages/documentation folder: ```sh -$ pnpm build +$ pnpm build:docs ``` This command generates static content into the build directory and can be served using any static contents hosting service. diff --git a/packages/documentation/netlify.toml b/packages/documentation/netlify.toml index cd2630ebe3..0d0bb5929c 100644 --- a/packages/documentation/netlify.toml +++ b/packages/documentation/netlify.toml @@ -14,4 +14,4 @@ publish = "build/" # Default build command. - command = "pnpm install --no-frozen-lockfile && pnpm dlx playwright install chromium && pnpm build" + command = "pnpm install --no-frozen-lockfile && pnpm dlx playwright install chromium && pnpm build:docs" diff --git a/packages/documentation/package.json b/packages/documentation/package.json index 003b8bc1b7..d9735ba985 100644 --- a/packages/documentation/package.json +++ b/packages/documentation/package.json @@ -4,7 +4,7 @@ "version": "0.0.1", "scripts": { "start": "astro dev", - "build": "astro build", + "build:docs": "astro build", "preview": "astro preview", "astro": "astro" }, diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 0d293d06bf..f98dfba596 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -181,7 +181,7 @@ importers: specifier: ^8.16.1 version: 8.16.1 token-introspection: - specifier: workspace:../token-introspection + specifier: workspace:* version: link:../token-introspection uuid: specifier: ^9.0.1 @@ -365,7 +365,7 @@ importers: specifier: ^0.13.57 version: 0.13.57 token-introspection: - specifier: workspace:../token-introspection + specifier: workspace:* version: link:../token-introspection uuid: specifier: ^9.0.1