docs: unify d.ts example filename to apollo.d.ts - #13261
Conversation
✅ Docs preview readyThe preview is ready to be viewed. View the preview File Changes 0 new, 3 changed, 0 removedBuild ID: f481bb866a120b055e6a7049 URL: https://www.apollographql.com/docs/deploy-preview/f481bb866a120b055e6a7049
|
|
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Repository UI (base), Organization UI (inherited) Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (3)
📝 WalkthroughWalkthroughThis PR updates documentation examples across three files to consistently rename TypeScript declaration filename references from ChangesDocumentation filename update
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Suggested labels
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ 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
docs/source/data/fragments.mdxESLint skipped: missing config or dependency (missing-dependency). The ESLint configuration references a package that is not available in the sandbox. docs/source/data/typescript.mdxESLint skipped: the ESLint configuration for this file references a package that is not available in the sandbox. docs/source/migrating/apollo-client-4-migration.mdxESLint 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. Comment |
commit: |
jerelmiller
left a comment
There was a problem hiding this comment.
VERY good catch! Thanks so much!
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 itapollo.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.tsexamples toapollo.d.ts, which is the name used in the Apollo Client 4.2 blog post.Summary by CodeRabbit