diff --git a/invokeai/frontend/web/docs/README.md b/invokeai/frontend/web/docs/README.md index 5f9e3c2c55..2545206c6a 100644 --- a/invokeai/frontend/web/docs/README.md +++ b/invokeai/frontend/web/docs/README.md @@ -14,6 +14,7 @@ - [i18next & Weblate](#i18next--weblate) - [openapi-typescript](#openapi-typescript) - [reactflow](#reactflow) + - [zod](#zod) - [Client Types Generation](#client-types-generation) - [Package Scripts](#package-scripts) - [Contributing](#contributing) @@ -31,50 +32,50 @@ InvokeAI's UI is made possible by a number of excellent open-source libraries. T ### Redux Toolkit -[Redux Toolkit](https://github.com/reduxjs/redux-toolkit) is used for state management and fetching/caching: +[Redux Toolkit] is used for state management and fetching/caching: - `RTK-Query` for data fetching and caching - `createAsyncThunk` for a couple other HTTP requests - `createEntityAdapter` to normalize things like images and models - `createListenerMiddleware` for async workflows -We use [redux-remember](https://github.com/zewish/redux-remember) for persistence. +We use [redux-remember] for persistence. ### Socket\.IO -[Socket\.IO](https://github.com/socketio/socket.io) is used for server-to-client events, like generation process and queue state changes. +[Socket.IO] is used for server-to-client events, like generation process and queue state changes. ### Chakra UI -[Chakra UI](https://github.com/chakra-ui/chakra-ui) is our primary UI library, but we also use a few components from [Mantine v6](https://v6.mantine.dev/). +[Chakra UI] is our primary UI library, but we also use a few components from [Mantine v6]. ### KonvaJS -[KonvaJS](https://github.com/konvajs/react-konva) powers the canvas. In the future, we'd like to explore [PixiJS](https://github.com/pixijs/pixijs) or WebGPU. +[KonvaJS] powers the canvas. In the future, we'd like to explore [PixiJS] or WebGPU. ### Vite -[Vite](https://github.com/vitejs/vite) is our bundler. +[Vite] is our bundler. ### i18next & Weblate -We use [i18next](https://github.com/i18next/react-i18next) for localization, but translation to languages other than English happens on our [Weblate](https://hosted.weblate.org/engage/invokeai/) project. **Only the English source strings should be changed on this repo.** +We use [i18next] for localization, but translation to languages other than English happens on our [Weblate] project. **Only the English source strings should be changed on this repo.** ### openapi-typescript -[openapi-typescript](https://github.com/drwpow/openapi-typescript) is used to generate types from the server's OpenAPI schema. See TYPES_CODEGEN.md. +[openapi-typescript] is used to generate types from the server's OpenAPI schema. See TYPES_CODEGEN.md. ### reactflow -[reactflow](https://github.com/xyflow/xyflow) powers the Workflow Editor. +[reactflow] powers the Workflow Editor. ### zod -[zod](https://github.com/colinhacks/zod) schemas are used to model data structures and provide runtime validation. +[zod] schemas are used to model data structures and provide runtime validation. ## Client Types Generation -We use [`openapi-typescript`](https://github.com/drwpow/openapi-typescript) to generate types from the app's OpenAPI schema. +We use [openapi-typescript] to generate types from the app's OpenAPI schema. The generated types are written to `invokeai/frontend/web/src/services/api/schema.d.ts`. This file is committed to the repo. @@ -107,11 +108,11 @@ Run with `yarn