diff --git a/docs/docs/api.md b/docs/docs/api.md index 9336fcf40d..2e8ab5eb1b 100644 --- a/docs/docs/api.md +++ b/docs/docs/api.md @@ -7,7 +7,7 @@ Immich uses the [OpenAPI](https://swagger.io/specification/) standard to generat OpenAPI is used to generate the client (Typescript, Dart) SDK. `openapi-generator-cli` can be installed [here](https://openapi-generator.tech/docs/installation/). The generated SDK is based on the `immich-openapi-specs.json` file, which is autogenerated by the server **when running in development mode**. The `immich-openapi-specs.json` file can be modified with `@nestjs/swagger` decorators used or referenced by controller endpoints. See the [NestJS OpenAPI docs](https://docs.nestjs.com/openapi/types-and-parameters) for more info. When you add a new endpoint or modify an existing one, you must run the server in development mode and run the command below to update the client SDK. ```bash -make open-api +mise open-api ``` You can find the generated client SDK in the `packages/sdk/client` for Typescript SDK and `mobile/openapi` for Dart SDK. diff --git a/docs/docs/developer/devcontainers.md b/docs/docs/developer/devcontainers.md index 27004215d5..459bfa56c5 100644 --- a/docs/docs/developer/devcontainers.md +++ b/docs/docs/developer/devcontainers.md @@ -218,7 +218,7 @@ When the Dev Container starts, it automatically: - Debug ports: 9230 (workers), 9231 (API) :::info -The Dev Container setup replaces the `make dev` command from the traditional setup. All services start automatically when you open the container. +The Dev Container setup replaces the `mise dev` command from the traditional setup. All services start automatically when you open the container. ::: ### Accessing Services diff --git a/docs/docs/developer/pr-checklist.md b/docs/docs/developer/pr-checklist.md index bab9924126..4ad232a312 100644 --- a/docs/docs/developer/pr-checklist.md +++ b/docs/docs/developer/pr-checklist.md @@ -2,7 +2,7 @@ A minimal devcontainer is supplied with this repository. All commands can be executed directly inside this container to avoid tedious installation of the environment. :::warning -The provided devcontainer isn't complete at the moment. At least all dockerized steps in the Makefile won't work (`make dev`, ....). Feel free to contribute! +The provided devcontainer isn't complete at the moment. At least all dockerized steps in the Makefile won't work (`mise dev`, ....). Feel free to contribute! ::: When contributing code through a pull request, please check the following: diff --git a/docs/docs/developer/setup.md b/docs/docs/developer/setup.md index cac9f501d8..167fa10320 100644 --- a/docs/docs/developer/setup.md +++ b/docs/docs/developer/setup.md @@ -45,7 +45,7 @@ All the services are packaged to run as with single Docker Compose command. 5. From the root directory, run: ```bash title="Start development server" -make dev # required Makefile installed on the system. +mise dev ``` 5. Access the dev instance in your browser at http://localhost:3000, or connect via the mobile app. @@ -88,7 +88,7 @@ To see local changes to `@immich/ui` in Immich, do the following: 3. Uncomment the corresponding volume in web service of the `docker/docker-compose.dev.yml` file (`../../ui:/usr/src/ui`) 4. Uncomment the corresponding alias in the `web/vite.config.ts` file (`'@immich/ui': path.resolve(\_\_dirname, '../../ui/packages/ui')`) 5. Uncomment the import statement in `web/src/app.css` file `@import '../../../ui/packages/ui/dist/theme/default.css';` and comment out `@import '@immich/ui/theme/default.css';` -6. Start up the stack via `make dev` +6. Start up the stack via `mise dev` 7. After making changes in `@immich/ui`, rebuild it (`pnpm run build`) ### Mobile app diff --git a/docs/docs/developer/testing.md b/docs/docs/developer/testing.md index 7f8ed629e0..d7224d311b 100644 --- a/docs/docs/developer/testing.md +++ b/docs/docs/developer/testing.md @@ -12,7 +12,7 @@ You need to run `mise //server:install` before _once_. The e2e tests can be run by first starting up a test production environment via: ```bash -make e2e +mise e2e ``` Before you can run the tests, you need to run the following commands _once_: