Skip to content

Conversation

@colinmurphy
Copy link
Member

Tasks

  • I have signed a Contributor License Agreement (CLA) with WP Engine.
  • If a code change, I have written testing instructions that the whole team & outside contributors can understand.
  • I have written and included a comprehensive changeset to properly document the changes I've made.

Description

This pull request updates documentation to clarify support for Apollo Client version 3 in Faust.js, ensuring users install the correct version and understand compatibility limitations. The changes also specify that Faust.js currently works with the Next.js pages router, helping prevent setup issues.

Apollo Client versioning and compatibility:

  • Updated references in documentation to specify usage of @apollo/client@3 instead of a generic @apollo/client, ensuring users install the supported version. [1] [2] [3] [4]
  • Added a note explaining that Faust.js currently supports Apollo Client 3.x and that Apollo Client 4 is not supported, warning users of potential integration issues.

Next.js setup clarification:

  • Updated setup instructions to specify that Faust.js works with a Next.js project using the pages router, clarifying requirements for new users.

Related Issue(s):

Testing

Screenshots

Documentation Changes

Dependant PRs

@colinmurphy colinmurphy requested a review from a team as a code owner October 3, 2025 18:35
@changeset-bot
Copy link

changeset-bot bot commented Oct 3, 2025

⚠️ No Changeset found

Latest commit: 29ab68b

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@colinmurphy colinmurphy enabled auto-merge (squash) October 3, 2025 18:36
@colinmurphy colinmurphy disabled auto-merge October 3, 2025 18:36
@github-actions
Copy link
Contributor

github-actions bot commented Oct 3, 2025

📦 Next.js Bundle Analysis for @faustwp/getting-started-example

This analysis was generated by the Next.js Bundle Analysis action. 🤖

This PR introduced no changes to the JavaScript bundle! 🙌

@colinmurphy colinmurphy merged commit 729d144 into canary Oct 6, 2025
4 checks passed
@colinmurphy colinmurphy deleted the chore-docs-update-faust-apollo-client branch October 6, 2025 15:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants