Skip to content

Commit 729d144

Browse files
authored
Updated docs to use Apollo Client version 3 as Faust currently does not support version 4. (#2189)
1 parent 83b8e5d commit 729d144

File tree

4 files changed

+9
-5
lines changed

4 files changed

+9
-5
lines changed

docs/explanation/apollo-client-basics/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: "Apollo Client Basics"
33
description: "Learn about core Apollo Client concepts like queries, fragments, mutations, and caching as they relate to Faust.js and WordPress."
44
---
55

6-
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.
6+
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.
77

88
## Apollo Client GraphQL Concepts
99

docs/explanation/telemetry/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Faust collects completely anonymous telemetry data about general usage. Particip
2323
- `@faustwp/blocks` version
2424
- `@faustwp/block-editor-utils` version
2525
- `@faustwp/experimental-app-router` version
26-
- `@apollo/client` version
26+
- `@apollo/client@3` version
2727
- Node version
2828
- Next.js version
2929
- If the Node environment is in **dev mode** (i.e., whether `npm run dev` was run)

docs/how-to/basic-setup/index.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ In order to leverage any of the tools in the Faust.js toolkit, some preliminary
1010
Before you begin, you'll need:
1111

1212
- A WordPress site (local or remote), if you don't have one yet, we recommend setting up a local WordPress development environment.
13-
- 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.
13+
- 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.
1414

1515
> [!INFO]- local WordPress development
1616
> 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.
4646
Install the required NPM packages in your Next.js app.
4747

4848
```bash
49-
npm install @apollo/client @faustwp/core graphql @faustwp/cli
49+
npm install @apollo/client@3 @faustwp/core graphql @faustwp/cli
5050
```
5151

52+
> [!NOTE]
53+
> Faust currently supports Apollo Client 3.x. Apollo Client 4 is not supported and may break Faust integrations.
54+
55+
5256
### D. Create Faust config file
5357

5458
Create a `faust.config.js` file in the root of your project with this code:

docs/how-to/migrate-from-legacy-faust/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ Create a list of components that can be reused in the new version of Faust and m
148148
Start by installing the Faust.js core packages and dependencies in your terminal:
149149
150150
```bash
151-
npm i @faustwp/cli @faustwp/core graphql @apollo/client
151+
npm i @faustwp/cli @faustwp/core graphql @apollo/client@3
152152
```
153153
154154
Change the `package.json` scripts to use the new Faust cli:

0 commit comments

Comments
 (0)