diff --git a/docs/explanation/apollo-client-basics/index.md b/docs/explanation/apollo-client-basics/index.md index 5aa9d1713..7b016ab9b 100644 --- a/docs/explanation/apollo-client-basics/index.md +++ b/docs/explanation/apollo-client-basics/index.md @@ -3,7 +3,7 @@ title: "Apollo Client Basics" description: "Learn about core Apollo Client concepts like queries, fragments, mutations, and caching as they relate to Faust.js and WordPress." --- -Faust.js uses `@apollo/client` under the hood to perform GraphQL operations against your WordPress backend. Having a solid understanding of Apollo Client queries, fragments, and mutations will help you get the most out of Faust.js. +Faust.js uses `@apollo/client@3` under the hood to perform GraphQL operations against your WordPress backend. Having a solid understanding of Apollo Client queries, fragments, and mutations will help you get the most out of Faust.js. ## Apollo Client GraphQL Concepts diff --git a/docs/explanation/telemetry/index.md b/docs/explanation/telemetry/index.md index 943446508..49fcffab7 100644 --- a/docs/explanation/telemetry/index.md +++ b/docs/explanation/telemetry/index.md @@ -23,7 +23,7 @@ Faust collects completely anonymous telemetry data about general usage. Particip - `@faustwp/blocks` version - `@faustwp/block-editor-utils` version - `@faustwp/experimental-app-router` version -- `@apollo/client` version +- `@apollo/client@3` version - Node version - Next.js version - If the Node environment is in **dev mode** (i.e., whether `npm run dev` was run) diff --git a/docs/how-to/basic-setup/index.md b/docs/how-to/basic-setup/index.md index b4c221fea..611a174be 100644 --- a/docs/how-to/basic-setup/index.md +++ b/docs/how-to/basic-setup/index.md @@ -10,7 +10,7 @@ In order to leverage any of the tools in the Faust.js toolkit, some preliminary Before you begin, you'll need: - A WordPress site (local or remote), if you don't have one yet, we recommend setting up a local WordPress development environment. -- A Next.js project, if you don't have a Next.js project yet, [create one](https://nextjs.org/docs/getting-started/installation) on your local computer. +- A Next.js project (pages router), if you don't have a Next.js project yet, [create one](https://nextjs.org/docs/getting-started/installation) on your local computer. > [!INFO]- local WordPress development > There are lots of options for setting up a local WordPress development environment. Some popular choices include [LocalWP](https://localwp.com/), [`wp-env`](https://developer.wordpress.org/block-editor/getting-started/devenv/get-started-with-wp-env/), or [MAMP](https://www.mamp.info/en/). @@ -46,9 +46,13 @@ Save your `.env.local` file. Install the required NPM packages in your Next.js app. ```bash -npm install @apollo/client @faustwp/core graphql @faustwp/cli +npm install @apollo/client@3 @faustwp/core graphql @faustwp/cli ``` +> [!NOTE] +> Faust currently supports Apollo Client 3.x. Apollo Client 4 is not supported and may break Faust integrations. + + ### D. Create Faust config file Create a `faust.config.js` file in the root of your project with this code: diff --git a/docs/how-to/migrate-from-legacy-faust/index.md b/docs/how-to/migrate-from-legacy-faust/index.md index bc2fc48a7..442e0b8ea 100644 --- a/docs/how-to/migrate-from-legacy-faust/index.md +++ b/docs/how-to/migrate-from-legacy-faust/index.md @@ -148,7 +148,7 @@ Create a list of components that can be reused in the new version of Faust and m Start by installing the Faust.js core packages and dependencies in your terminal: ```bash -npm i @faustwp/cli @faustwp/core graphql @apollo/client +npm i @faustwp/cli @faustwp/core graphql @apollo/client@3 ``` Change the `package.json` scripts to use the new Faust cli: