Skip to content

docs: unify d.ts example filename to apollo.d.ts - #13261

Merged
jerelmiller merged 1 commit into
mainfrom
docs/unify-dts-filename
Jun 5, 2026
Merged

docs: unify d.ts example filename to apollo.d.ts#13261
jerelmiller merged 1 commit into
mainfrom
docs/unify-dts-filename

Conversation

@DaleSeo

@DaleSeo DaleSeo commented Jun 5, 2026

Copy link
Copy Markdown
Member

I noticed that the TypeScript docs is inconsistent about the name for the declaration file used for module augmentation. Some examples refer to it as apollo-client.d.ts, while others call it apollo.d.ts, and this can happen even within the same page and section. I'm concerned that this inconsistency can confuse readers and make them question if the two names have different meanings. So, I've standardized all the .d.ts examples to apollo.d.ts, which is the name used in the Apollo Client 4.2 blog post.

Summary by CodeRabbit

  • Documentation
    • Updated TypeScript declaration file examples throughout the documentation guides to maintain consistent filename references in code samples for better clarity across data fragments, type definitions, and migration sections.

@DaleSeo DaleSeo self-assigned this Jun 5, 2026
@DaleSeo
DaleSeo requested a review from a team as a code owner June 5, 2026 00:22
@apollo-librarian

apollo-librarian Bot commented Jun 5, 2026

Copy link
Copy Markdown
Contributor

✅ Docs preview ready

The preview is ready to be viewed. View the preview

File Changes

0 new, 3 changed, 0 removed
* (developer-tools)/react/(latest)/data/fragments.mdx
* (developer-tools)/react/(latest)/data/typescript.mdx
* (developer-tools)/react/(latest)/migrating/apollo-client-4-migration.mdx

Build ID: f481bb866a120b055e6a7049
Build Logs: View logs

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


⚠️ AI Style Review — 2 Issues Found

Summary

The pull request updates the documentation to align with style guide standards. Key changes include refining framing by removing potentially condescending terms like 'easily' and adopting a direct, imperative mood for instructions. The voice has been shifted to be more authoritative and opinionated, prescribing specific paths instead of multiple options, and using active voice for clarity. Technical formatting was corrected to use code font for file extensions like .d.ts, and directional language was replaced with specific terms like 'following' to improve accessibility and future-proof referencing.

Duration: 3075ms
Review Log: View detailed log

This review is AI-generated. Please use common sense when accepting these suggestions, as they may not always be accurate or appropriate for your specific context.

@changeset-bot

changeset-bot Bot commented Jun 5, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 6fca4ff

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

@coderabbitai

coderabbitai Bot commented Jun 5, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI (base), Organization UI (inherited)

Review profile: CHILL

Plan: Pro

Run ID: e2c067c8-a498-4754-bbce-9aafaf9075f3

📥 Commits

Reviewing files that changed from the base of the PR and between 5e8b651 and 6fca4ff.

📒 Files selected for processing (3)
  • docs/source/data/fragments.mdx
  • docs/source/data/typescript.mdx
  • docs/source/migrating/apollo-client-4-migration.mdx

📝 Walkthrough

Walkthrough

This PR updates documentation examples across three files to consistently rename TypeScript declaration filename references from apollo-client.d.ts to apollo.d.ts. Changes affect code fence headers and accompanying text in data masking, context configuration, type override, and migration guide sections.

Changes

Documentation filename update

Layer / File(s) Summary
Update TypeScript declaration filename references across documentation
docs/source/data/fragments.mdx, docs/source/data/typescript.mdx, docs/source/migrating/apollo-client-4-migration.mdx
Renamed apollo-client.d.ts to apollo.d.ts in code fence headers and surrounding note text across data masking types examples, custom context properties, link context options, type override mappings, custom dataState types, incremental delivery handlers, and migration guide sections.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested labels

auto-cleanup

Suggested reviewers

  • pragl
  • jerelmiller

Poem

A rabbit hops through docs so neat,
With filenames made complete,
apollo.d.ts now shines bright,
Where apollo-client.d.ts took flight,
Consistency wears its banner sweet! 🐰✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely summarizes the main change: unifying TypeScript declaration file examples from inconsistent filenames (apollo-client.d.ts and apollo.d.ts) to a single standardized filename (apollo.d.ts) across documentation files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

docs/source/data/fragments.mdx

ESLint skipped: missing config or dependency (missing-dependency). The ESLint configuration references a package that is not available in the sandbox.

docs/source/data/typescript.mdx

ESLint skipped: the ESLint configuration for this file references a package that is not available in the sandbox.

docs/source/migrating/apollo-client-4-migration.mdx

ESLint skipped: the ESLint configuration for this file references a package that is not available in the sandbox.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@pkg-pr-new

pkg-pr-new Bot commented Jun 5, 2026

Copy link
Copy Markdown
npm i https://pkg.pr.new/apollographql/apollo-client/@apollo/client@13261

commit: 6fca4ff

@jerelmiller jerelmiller left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

VERY good catch! Thanks so much!

@github-actions github-actions Bot added the auto-cleanup 🤖 label Jun 5, 2026
@jerelmiller
jerelmiller merged commit e45bbfb into main Jun 5, 2026
48 checks passed
@jerelmiller
jerelmiller deleted the docs/unify-dts-filename branch June 5, 2026 00:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants