Reorganize TypeScript docs #12847

jerelmiller · 2025-08-18T20:41:56Z

Splits the TypeScript guide into two pages:

A general purpose TypeScript guide
Using with GraphQL Codegen

changeset-bot · 2025-08-18T20:42:00Z

⚠️ No Changeset found

Latest commit: c039b97

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

docs/source/_sidebar.yaml

  - label: Changelog
    href: https://github.com/apollographql/apollo-client/blob/main/CHANGELOG.md
-  - label: Fetching
+  - label: Core functionality


jerelmiller · 2025-08-18T20:43:13Z

docs/source/_sidebar.yaml

        href: ./data/fragments
      - label: Mutations
        href: ./data/mutations
+      - label: TypeScript


I added this below the operations docs as I felt it was pretty important and wanted it more prominent. Let me know if you prefer a different ordering in this section.

Totally agree, this point can't come up soon enough :)

pkg-pr-new · 2025-08-18T20:43:23Z

npm i https://pkg.pr.new/apollographql/apollo-client/@apollo/client@12847

commit: c039b97

github-actions · 2025-08-18T20:43:59Z

size-limit report 📦

Path	Size
import { ApolloClient, InMemoryCache, HttpLink } from "@apollo/client" (CJS)	42.89 KB (0%)
import { ApolloClient, InMemoryCache, HttpLink } from "@apollo/client" (production) (CJS)	37.72 KB (0%)
import { ApolloClient, InMemoryCache, HttpLink } from "@apollo/client"	32.83 KB (0%)
import { ApolloClient, InMemoryCache, HttpLink } from "@apollo/client" (production)	27.01 KB (0%)
import { ApolloProvider } from "@apollo/client/react"	5.91 KB (0%)
import { ApolloProvider } from "@apollo/client/react" (production)	970 B (0%)
import { useQuery } from "@apollo/client/react"	7.22 KB (0%)
import { useQuery } from "@apollo/client/react" (production)	2.23 KB (0%)
import { useLazyQuery } from "@apollo/client/react"	7.1 KB (0%)
import { useLazyQuery } from "@apollo/client/react" (production)	2.14 KB (0%)
import { useMutation } from "@apollo/client/react"	6.46 KB (0%)
import { useMutation } from "@apollo/client/react" (production)	1.48 KB (0%)
import { useSubscription } from "@apollo/client/react"	6.77 KB (0%)
import { useSubscription } from "@apollo/client/react" (production)	1.79 KB (0%)
import { useSuspenseQuery } from "@apollo/client/react"	8.58 KB (0%)
import { useSuspenseQuery } from "@apollo/client/react" (production)	3.62 KB (0%)
import { useBackgroundQuery } from "@apollo/client/react"	8.32 KB (0%)
import { useBackgroundQuery } from "@apollo/client/react" (production)	3.38 KB (0%)
import { useLoadableQuery } from "@apollo/client/react"	8.28 KB (0%)
import { useLoadableQuery } from "@apollo/client/react" (production)	3.36 KB (0%)
import { useReadQuery } from "@apollo/client/react"	6.58 KB (0%)
import { useReadQuery } from "@apollo/client/react" (production)	1.63 KB (0%)
import { useFragment } from "@apollo/client/react"	6.65 KB (0%)
import { useFragment } from "@apollo/client/react" (production)	1.71 KB (0%)

apollo-librarian · 2025-08-18T20:45:09Z

✅ Docs preview ready

The preview is ready to be viewed. View the preview

File Changes

28 new, 65 changed, 6 removed

+ (developer-tools)/react/(latest)/api/link/apollo-link-base-batch-http.mdx
+ (developer-tools)/react/(latest)/api/link/apollo-link-base-http.mdx
+ (developer-tools)/react/(latest)/api/link/apollo-link-batch.mdx
+ (developer-tools)/react/(latest)/api/link/apollo-link-client-awareness.mdx
+ (developer-tools)/react/(latest)/api/link/apollo-link.mdx
+ (developer-tools)/react/(latest)/api/react/ApolloProvider.mdx
+ (developer-tools)/react/(latest)/api/react/skipToken.mdx
+ (developer-tools)/react/(latest)/api/react/useApolloClient.mdx
+ (developer-tools)/react/(latest)/api/react/useBackgroundQuery.mdx
+ (developer-tools)/react/(latest)/api/react/useFragment.mdx
+ (developer-tools)/react/(latest)/api/react/useLazyQuery.mdx
+ (developer-tools)/react/(latest)/api/react/useLoadableQuery.mdx
+ (developer-tools)/react/(latest)/api/react/useMutation.mdx
+ (developer-tools)/react/(latest)/api/react/useQuery.mdx
+ (developer-tools)/react/(latest)/api/react/useQueryRefHandlers.mdx
+ (developer-tools)/react/(latest)/api/react/useReactiveVar.mdx
+ (developer-tools)/react/(latest)/api/react/useReadQuery.mdx
+ (developer-tools)/react/(latest)/api/react/useSubscription.mdx
+ (developer-tools)/react/(latest)/api/react/useSuspenseQuery.mdx
+ (developer-tools)/react/(latest)/api/errors/CombinedGraphQLErrors.mdx
+ (developer-tools)/react/(latest)/api/errors/CombinedProtocolErrors.mdx
+ (developer-tools)/react/(latest)/api/errors/LinkError.mdx
+ (developer-tools)/react/(latest)/api/errors/LocalStateError.mdx
+ (developer-tools)/react/(latest)/api/errors/ServerError.mdx
+ (developer-tools)/react/(latest)/api/errors/ServerParseError.mdx
+ (developer-tools)/react/(latest)/api/errors/UnconventionalError.mdx
+ (developer-tools)/react/(latest)/data/typescript.mdx
+ (developer-tools)/react/(latest)/development-testing/graphql-codegen.mdx
* (developer-tools)/react/(latest)/get-started.mdx
* (developer-tools)/react/(latest)/index.mdx
* (developer-tools)/react/(latest)/why-apollo.mdx
* (developer-tools)/react/(latest)/api/cache/InMemoryCache.mdx
* (developer-tools)/react/(latest)/api/core/ApolloClient.mdx
* (developer-tools)/react/(latest)/api/core/ObservableQuery.mdx
* (developer-tools)/react/(latest)/api/link/apollo-link-batch-http.mdx
* (developer-tools)/react/(latest)/api/link/apollo-link-context.mdx
* (developer-tools)/react/(latest)/api/link/apollo-link-error.mdx
* (developer-tools)/react/(latest)/api/link/apollo-link-http.mdx
* (developer-tools)/react/(latest)/api/link/apollo-link-remove-typename.mdx
* (developer-tools)/react/(latest)/api/link/apollo-link-retry.mdx
* (developer-tools)/react/(latest)/api/link/apollo-link-schema.mdx
* (developer-tools)/react/(latest)/api/link/apollo-link-subscriptions.mdx
* (developer-tools)/react/(latest)/api/link/apollo-link-ws.mdx
* (developer-tools)/react/(latest)/api/link/community-links.mdx
* (developer-tools)/react/(latest)/api/link/introduction.mdx
* (developer-tools)/react/(latest)/api/link/persisted-queries.mdx
* (developer-tools)/react/(latest)/api/react/hooks.mdx
* (developer-tools)/react/(latest)/api/react/preloading.mdx
* (developer-tools)/react/(latest)/api/react/ssr.mdx
* (developer-tools)/react/(latest)/api/react/testing.mdx
* (developer-tools)/react/(latest)/caching/advanced-topics.mdx
* (developer-tools)/react/(latest)/caching/cache-configuration.mdx
* (developer-tools)/react/(latest)/caching/cache-field-behavior.mdx
* (developer-tools)/react/(latest)/caching/cache-interaction.mdx
* (developer-tools)/react/(latest)/caching/garbage-collection.mdx
* (developer-tools)/react/(latest)/caching/memory-management.mdx
* (developer-tools)/react/(latest)/caching/overview.mdx
* (developer-tools)/react/(latest)/data/defer.mdx
* (developer-tools)/react/(latest)/data/directives.mdx
* (developer-tools)/react/(latest)/data/document-transforms.mdx
* (developer-tools)/react/(latest)/data/error-handling.mdx
* (developer-tools)/react/(latest)/data/file-uploads.mdx
* (developer-tools)/react/(latest)/data/fragments.mdx
* (developer-tools)/react/(latest)/data/mutations.mdx
* (developer-tools)/react/(latest)/data/operation-best-practices.mdx
* (developer-tools)/react/(latest)/data/queries.mdx
* (developer-tools)/react/(latest)/data/refetching.mdx
* (developer-tools)/react/(latest)/data/subscriptions.mdx
* (developer-tools)/react/(latest)/data/suspense.mdx
* (developer-tools)/react/(latest)/development-testing/client-schema-mocking.mdx
* (developer-tools)/react/(latest)/development-testing/developer-tooling.mdx
* (developer-tools)/react/(latest)/development-testing/schema-driven-testing.mdx
* (developer-tools)/react/(latest)/development-testing/testing.mdx
* (developer-tools)/react/(latest)/integrations/integrations.mdx
* (developer-tools)/react/(latest)/integrations/react-native.mdx
* (developer-tools)/react/(latest)/integrations/webpack.mdx
* (developer-tools)/react/(latest)/local-state/local-resolvers.mdx
* (developer-tools)/react/(latest)/local-state/local-state-management.mdx
* (developer-tools)/react/(latest)/local-state/managing-state-with-field-policies.mdx
* (developer-tools)/react/(latest)/local-state/reactive-variables.mdx
* (developer-tools)/react/(latest)/migrating/apollo-client-3-migration.mdx
* (developer-tools)/react/(latest)/networking/advanced-http-networking.mdx
* (developer-tools)/react/(latest)/networking/authentication.mdx
* (developer-tools)/react/(latest)/networking/basic-http-networking.mdx
* (developer-tools)/react/(latest)/pagination/core-api.mdx
* (developer-tools)/react/(latest)/pagination/cursor-based.mdx
* (developer-tools)/react/(latest)/pagination/key-args.mdx
* (developer-tools)/react/(latest)/pagination/offset-based.mdx
* (developer-tools)/react/(latest)/performance/babel.mdx
* (developer-tools)/react/(latest)/performance/optimistic-ui.mdx
* (developer-tools)/react/(latest)/performance/performance.mdx
* (developer-tools)/react/(latest)/performance/server-side-rendering.mdx
* (developer-tools)/react/(latest)/_sidebar.yaml
- (developer-tools)/react/(latest)/api/link/apollo-link-rest.mdx
- (developer-tools)/react/(latest)/api/react/components.mdx
- (developer-tools)/react/(latest)/api/react/hoc.mdx
- (developer-tools)/react/(latest)/development-testing/static-typing.mdx
- (developer-tools)/react/(latest)/local-state/client-side-schema.mdx
- (developer-tools)/react/(latest)/migrating/hooks-migration.mdx

Build ID: e3a727e7615a014077b87878
Build Logs: View logs

URL: https://www.apollographql.com/docs/deploy-preview/e3a727e7615a014077b87878

docs/source/_sidebar.yaml

phryneas

Love it! :)

jerelmiller added 12 commits August 18, 2025 13:56

Copy TypeScript page to new location

0dbc70c

Rename fetching to core functionality

160715c

Copy typescript doc to graphql-codegen

07d43eb

Remove old static typing page. Add redirect

930d833

Fix typo

721db37

Update description

212c49e

Update intro, remove setup section, update operation types section

5e7cd0e

Remove advanced codegen section

3f92fd8

Rework tip

0e70905

Remove statement about codegen in tip

50ab947

Add manual types

473d13f

Update codegen page

aa597b8

jerelmiller requested a review from phryneas August 18, 2025 20:41

jerelmiller requested a review from a team as a code owner August 18, 2025 20:41

jerelmiller commented Aug 18, 2025

View reviewed changes

docs/source/_sidebar.yaml Outdated

- label: Changelog

href: https://github.com/apollographql/apollo-client/blob/main/CHANGELOG.md

- label: Fetching

- label: Core functionality

This comment was marked as resolved.

Sign in to view

jerelmiller commented Aug 18, 2025

View reviewed changes

jerelmiller mentioned this pull request Aug 19, 2025

Split up the persisted query guide #12848

Merged

jerelmiller commented Aug 19, 2025

View reviewed changes

docs/source/_sidebar.yaml Outdated Show resolved Hide resolved

Update label

431c245

phryneas approved these changes Aug 19, 2025

View reviewed changes

github-actions bot added the auto-cleanup 🤖 label Aug 19, 2025

jerelmiller added 4 commits August 19, 2025 08:28

Fix grammar error

8998655

Fix broken link

d2020dd

Merge branch 'release-4.0' into jerel/ts-reorg

c24bd7e

Fix grammar

c039b97

jerelmiller merged commit a7a1e89 into release-4.0 Aug 19, 2025
44 checks passed

jerelmiller deleted the jerel/ts-reorg branch August 19, 2025 14:42

github-actions bot locked as resolved and limited conversation to collaborators Sep 19, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Reorganize TypeScript docs #12847

Reorganize TypeScript docs #12847

Uh oh!

jerelmiller commented Aug 18, 2025

Uh oh!

changeset-bot bot commented Aug 18, 2025 •

edited

Loading

Uh oh!

This comment was marked as resolved.

Uh oh!

jerelmiller Aug 18, 2025

Uh oh!

phryneas Aug 19, 2025

Uh oh!

pkg-pr-new bot commented Aug 18, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Aug 18, 2025 •

edited

Loading

Uh oh!

apollo-librarian bot commented Aug 18, 2025 •

edited

Loading

Uh oh!

Uh oh!

phryneas left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Reorganize TypeScript docs #12847

Reorganize TypeScript docs #12847

Uh oh!

Conversation

jerelmiller commented Aug 18, 2025

Uh oh!

changeset-bot bot commented Aug 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚠️ No Changeset found

Uh oh!

This comment was marked as resolved.

Uh oh!

jerelmiller Aug 18, 2025

Choose a reason for hiding this comment

Uh oh!

phryneas Aug 19, 2025

Choose a reason for hiding this comment

Uh oh!

pkg-pr-new bot commented Aug 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Aug 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

size-limit report 📦

Uh oh!

apollo-librarian bot commented Aug 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Docs preview ready

Uh oh!

Uh oh!

phryneas left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

changeset-bot bot commented Aug 18, 2025 •

edited

Loading

pkg-pr-new bot commented Aug 18, 2025 •

edited

Loading

github-actions bot commented Aug 18, 2025 •

edited

Loading

apollo-librarian bot commented Aug 18, 2025 •

edited

Loading