docs: reorganize integrations/adapters navs#571
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
Caution Review failedThe pull request is closed. WalkthroughThis update reorganizes the documentation structure by merging "Integrations" into "Adapters," renaming and consolidating sidebar sections, and updating documentation links and titles to reflect the new organization. Numerous internal documentation URLs, headings, and references were updated to maintain consistency with the new structure. No functional code changes were made. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Docs Sidebar
participant Adapters Docs
participant Integrations Docs
User->>Docs Sidebar: Opens documentation
Docs Sidebar->>Adapters Docs: Shows consolidated Adapters (with integrations inside)
Docs Sidebar-->>Integrations Docs: (No longer directly accessible)
User->>Adapters Docs: Accesses integration docs as Adapter sub-items
Possibly related PRs
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (2)
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
Codecov ReportAll modified and coverable lines are covered by tests ✅ 📢 Thoughts on this report? Let us know! |
More templates
@orpc/arktype
@orpc/client
@orpc/contract
@orpc/hey-api
@orpc/nest
@orpc/openapi
@orpc/openapi-client
@orpc/react
@orpc/react-query
@orpc/server
@orpc/shared
@orpc/solid-query
@orpc/standard-server
@orpc/standard-server-aws-lambda
@orpc/standard-server-fetch
@orpc/standard-server-node
@orpc/standard-server-peer
@orpc/svelte-query
@orpc/tanstack-query
@orpc/valibot
@orpc/vue-colada
@orpc/vue-query
@orpc/zod
commit: |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (1)
apps/content/docs/adapters/solid-start.md (1)
8-8: Hyphenate compound adjective. Consider changing “full stack JavaScript framework” to “full-stack JavaScript framework” for grammatical correctness.🧰 Tools
🪛 LanguageTool
[uncategorized] ~8-~8: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...Start](https://start.solidjs.com/) is a full stack JavaScript framework for building web a...(EN_COMPOUND_ADJECTIVE_INTERNAL)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (55)
apps/content/.vitepress/config.ts(3 hunks)apps/content/docs/adapters/astro.md(2 hunks)apps/content/docs/adapters/browser.md(1 hunks)apps/content/docs/adapters/electron.md(1 hunks)apps/content/docs/adapters/elysia.md(1 hunks)apps/content/docs/adapters/express.md(1 hunks)apps/content/docs/adapters/fastify.md(1 hunks)apps/content/docs/adapters/hono.md(1 hunks)apps/content/docs/adapters/message-port.md(1 hunks)apps/content/docs/adapters/next.md(1 hunks)apps/content/docs/adapters/nuxt.md(1 hunks)apps/content/docs/adapters/react-native.md(1 hunks)apps/content/docs/adapters/remix.md(1 hunks)apps/content/docs/adapters/solid-start.md(1 hunks)apps/content/docs/adapters/svelte-kit.md(1 hunks)apps/content/docs/adapters/tanstack-start.md(1 hunks)apps/content/docs/adapters/worker-threads.md(1 hunks)apps/content/docs/best-practices/optimize-ssr.md(1 hunks)apps/content/docs/comparison.md(2 hunks)apps/content/docs/integrations/tanstack-query-old/react.md(1 hunks)apps/content/docs/integrations/tanstack-query-old/solid.md(1 hunks)apps/content/docs/integrations/tanstack-query-old/svelte.md(1 hunks)apps/content/docs/integrations/tanstack-query-old/vue.md(1 hunks)apps/content/docs/integrations/tanstack-query.md(1 hunks)apps/content/docs/openapi/integrations/implement-contract-in-nest.md(1 hunks)packages/hey-api/src/to-orpc-client.ts(1 hunks)packages/nest/README.md(1 hunks)packages/nest/src/implement.ts(1 hunks)packages/nest/src/utils.ts(1 hunks)packages/react-query/README.md(1 hunks)packages/react-query/src/general-utils.ts(1 hunks)packages/react-query/src/procedure-utils.ts(4 hunks)packages/react-query/src/router-utils.ts(1 hunks)packages/solid-query/README.md(1 hunks)packages/solid-query/src/general-utils.ts(1 hunks)packages/solid-query/src/procedure-utils.ts(4 hunks)packages/solid-query/src/router-utils.ts(1 hunks)packages/svelte-query/README.md(1 hunks)packages/svelte-query/src/general-utils.ts(1 hunks)packages/svelte-query/src/procedure-utils.ts(4 hunks)packages/svelte-query/src/router-utils.ts(1 hunks)packages/tanstack-query/src/general-utils.ts(1 hunks)packages/tanstack-query/src/procedure-utils.ts(4 hunks)packages/vue-colada/README.md(1 hunks)packages/vue-colada/src/general-utils.ts(1 hunks)packages/vue-colada/src/procedure-utils.ts(2 hunks)packages/vue-colada/src/router-utils.ts(1 hunks)packages/vue-query/README.md(1 hunks)packages/vue-query/src/general-utils.ts(1 hunks)packages/vue-query/src/procedure-utils.ts(4 hunks)packages/vue-query/src/router-utils.ts(1 hunks)playgrounds/next/src/lib/orpc.server.ts(1 hunks)playgrounds/next/src/lib/orpc.ts(1 hunks)playgrounds/solid-start/src/lib/orpc.server.ts(1 hunks)playgrounds/tanstack-start/src/lib/orpc.ts(1 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (6)
packages/vue-colada/src/procedure-utils.ts (1)
packages/client/src/types.ts (1)
Client(26-28)
packages/solid-query/src/procedure-utils.ts (1)
packages/client/src/types.ts (1)
Client(26-28)
packages/tanstack-query/src/procedure-utils.ts (1)
packages/client/src/types.ts (1)
Client(26-28)
packages/react-query/src/procedure-utils.ts (1)
packages/client/src/types.ts (1)
Client(26-28)
packages/vue-query/src/procedure-utils.ts (1)
packages/client/src/types.ts (1)
Client(26-28)
packages/svelte-query/src/procedure-utils.ts (1)
packages/client/src/types.ts (1)
Client(26-28)
🪛 LanguageTool
apps/content/docs/adapters/solid-start.md
[uncategorized] ~8-~8: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...Start](https://start.solidjs.com/) is a full stack JavaScript framework for building web a...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
packages/vue-colada/README.md
[misspelling] ~66-~66: Possible spelling mistakes found.
Context: ...# @orpc/vue-colada Integration with Pinia Colada. Read t...
(EN_MULTITOKEN_SPELLING_TWO)
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: lint
- GitHub Check: publish-commit
🔇 Additional comments (91)
packages/vue-colada/src/router-utils.ts (1)
22-22: Approve updated documentation linkThe JSDoc
@seeURL has been correctly updated to point to/docs/integrations/pinia-colada, matching the new documentation structure. No functional changes required.apps/content/docs/best-practices/optimize-ssr.md (1)
173-173: Approve TanStack Query link updateThe reference to the TanStack Query integration guide has been updated to
/docs/integrations/tanstack-query-old/basic, aligning with the reorganized docs hierarchy. No issues detected.playgrounds/solid-start/src/lib/orpc.server.ts (1)
12-12: Approve Adapter docs path changeThe JSDoc link now correctly points to
/docs/adapters/solid-start#optimize-ssr, reflecting the rename from “Integrations” to “Adapters.” This matches the overall restructuring.packages/vue-colada/src/general-utils.ts (1)
9-9: Approve Pinia Colada docs link adjustmentThe
@seeannotation now references/docs/integrations/pinia-colada#query-mutation-key, correctly reflecting the moved documentation location.packages/vue-colada/src/procedure-utils.ts (3)
12-12: Approve Calling Procedure Client docs updateThe JSDoc for
callnow links to/docs/integrations/pinia-colada#calling-procedure-clients, consistent with the reorganized docs.
19-19: Approve Query Options Utility docs updateThe
@seecomment forqueryOptionshas been updated to/docs/integrations/pinia-colada#query-options-utility, aligning with the new path.
30-30: Approve Mutation Options docs updateThe JSDoc for
mutationOptionsnow points to/docs/integrations/pinia-colada#mutation-options, correctly following the documentation restructure.apps/content/docs/integrations/tanstack-query-old/react.md (1)
8-8: Link updated to reflect new docs structure.
The “Basic Guide” link now correctly points to/docs/integrations/tanstack-query-old/basic, aligning with the reorganized sidebar.apps/content/docs/integrations/tanstack-query-old/solid.md (1)
8-8: Link updated to reflect new docs structure.
The “Basic Guide” link now correctly points to/docs/integrations/tanstack-query-old/basic, consistent with the React integration.apps/content/docs/openapi/integrations/implement-contract-in-nest.md (1)
3-3: Description updated for consistency.
The front matter description now uses “projects,” matching the overall docs tone.playgrounds/next/src/lib/orpc.server.ts (1)
10-10: @see link updated to adapters URL.
The JSDoc now referencesdocs/adapters/next#optimize-ssr, aligning with the renamed adapters section.packages/vue-colada/README.md (1)
66-66: Integration link updated to/docs/integrations/pinia-colada.
The documentation URL now reflects the consolidated integrations path.🧰 Tools
🪛 LanguageTool
[misspelling] ~66-~66: Possible spelling mistakes found.
Context: ...#@orpc/vue-coladaIntegration with Pinia Colada. Read t...(EN_MULTITOKEN_SPELLING_TWO)
packages/vue-query/src/router-utils.ts (1)
22-22: Update JSDoc link to new integrations path
The@seetag now correctly points to the relocated Vue Query documentation under/docs/integrations/tanstack-query-old/vue. This aligns with the broader reorganization and requires no functional adjustments.apps/content/docs/integrations/tanstack-query-old/svelte.md (1)
8-8: Correct introductory guide link
The link to the Basic Guide has been updated to/docs/integrations/tanstack-query-old/basic, matching the new directory structure. All references are consistent.apps/content/docs/adapters/browser.md (1)
2-2: Rename from Integration to Adapter
Both the document title and main heading have been revised from "Browser Integration" to "Browser Adapter" to reflect the updated terminology across the docs. Content remains accurate.Also applies to: 6-6
packages/solid-query/README.md (1)
66-66: Update Solid Query docs link
The README now references/docs/integrations/tanstack-query-old/solid, ensuring it points to the correct, reorganized integration guide.packages/svelte-query/README.md (1)
66-66: Update Svelte Query docs link
The README has been updated to point to/docs/integrations/tanstack-query-old/svelte, consistent with the relocated documentation structure.apps/content/docs/integrations/tanstack-query-old/vue.md (1)
8-8: Approved: Updated Basic Guide link
The introductory link now correctly points to/docs/integrations/tanstack-query-old/basic, matching the updated nav structure.playgrounds/next/src/lib/orpc.ts (1)
11-11: Approved: Updated JSDoc @see URL to adapters path
The@seelink now references/docs/adapters/next#optimize-ssr, consistent with the new documentation organization.packages/nest/README.md (1)
66-66: Approved: Updated NestJS documentation link
The docs link now points to/docs/openapi/integrations/implement-contract-in-nest, aligning with the reorganized OpenAPI integrations section.playgrounds/tanstack-start/src/lib/orpc.ts (1)
14-14: Approved: Updated JSDoc @see URL to adapters path
The@seetag now uses/docs/adapters/tanstack-start#optimize-ssr, consistent with the adapter naming conventions.apps/content/docs/integrations/tanstack-query.md (2)
2-2: Approved: Removed "(New)" from title
Thetitlefrontmatter was updated to "Tanstack Query Integration", removing the "(New)" suffix for clarity.
6-6: Approved: Updated main heading
The main heading now matches the updatedtitlewithout the "(New)" suffix.packages/svelte-query/src/router-utils.ts (1)
22-22: Docs: Update JSDoc @see link to new integrations pathThe
@seereference now correctly points to/docs/integrations/tanstack-query-old/svelte, matching the reorganized documentation structure.packages/vue-query/README.md (1)
66-66: Docs: Update Vue Query integration linkThe documentation link for Vue Query has been updated to
/docs/integrations/tanstack-query-old/vue, aligning with the consolidated adapters section.packages/solid-query/src/router-utils.ts (1)
22-22: Docs: Update JSDoc @see link to new integrations pathThe
@seereference now correctly points to/docs/integrations/tanstack-query-old/solid, ensuring consistency with the updated documentation layout.apps/content/docs/adapters/nuxt.md (2)
2-3: Docs: Rename frontmatter Integration to AdapterFrontmatter
titleanddescriptionhave been updated to reflect the "Adapter" terminology instead of "Integration." This aligns with the new naming convention across all framework guides.
6-6: Docs: Update main heading to AdapterThe main heading now reads "Nuxt.js Adapter" to match the updated title and maintain consistency with other adapter guides.
packages/react-query/README.md (1)
66-66: Docs: Update React Query integration linkThe documentation link for React Query now points to
/docs/integrations/tanstack-query-old/react, reflecting the reorganized adapters section.packages/react-query/src/router-utils.ts (1)
22-22: Update documentation link for Tanstack Query React
The@seeannotation now correctly points to the reorganized/docs/integrations/tanstack-query-old/reactpath. No functional changes here.apps/content/docs/adapters/remix.md (1)
2-3: Rename Remix Integration to Adapter
Frontmattertitleanddescription, along with the main heading, have been updated to "Remix Adapter," aligning with the new unified terminology.Also applies to: 6-6
apps/content/docs/adapters/worker-threads.md (1)
2-2: Rename Worker Threads Integration to Adapter
The documenttitleand primary heading have been updated to "Worker Threads Adapter," matching the consolidated Adapters section.Also applies to: 6-6
apps/content/docs/adapters/next.md (1)
2-3: Update Next.js Integration to Adapter
Thetitle,description, and main heading now consistently use "Next.js Adapter" to reflect the updated documentation structure.Also applies to: 6-6
packages/nest/src/utils.ts (1)
30-30: Approve JSDoc link updateThe
@seetag's URL has been correctly updated to the new integrations path for NestJS contract implementation.packages/solid-query/src/general-utils.ts (1)
12-12: Approve JSDoc reference updateThe
@seelink now points to the consolidated integrations path for Tanstack Query documentation.apps/content/docs/adapters/hono.md (2)
2-3: Confirm metadata terminologyThe frontmatter title and description have been correctly updated from "Hono Integration" to "Hono Adapter" to reflect the new adapter terminology.
6-6: Approve main heading updateThe document heading has been renamed to "Hono Adapter" for consistency with the updated metadata.
packages/svelte-query/src/general-utils.ts (1)
12-12: Approve JSDoc reference updateThe documentation link in the
@seetag correctly points to the legacy Tanstack Query integrations path.packages/react-query/src/general-utils.ts (1)
12-12: Approve JSDoc reference updateUpdated
@seelink to the/docs/integrations/tanstack-query-old/path, aligning with the broader docs restructuring.packages/tanstack-query/src/general-utils.ts (1)
11-11:Details
✅ Verification successful
Updated JSDoc link to reflect integrations route
The new URLhttps://orpc.unnoq.com/docs/integrations/tanstack-query-old/basic#query-mutation-keyaligns with the docs reorganization.
🏁 Script executed:
#!/bin/bash # Ensure no remaining references to the old docs path rg -n 'orpc.unnoq.com/docs/tanstack-query/basic#query-mutation-key'Length of output: 67
Docs JSDoc Link Updated and Verified
All occurrences of the old docs URL have been removed. The JSDoc in packages/tanstack-query/src/general-utils.ts now correctly points to the integrations route:
- Verified via
rg -n 'orpc.unnoq.com/docs/tanstack-query/basic#query-mutation-key'→ no matches found.apps/content/docs/adapters/elysia.md (2)
2-3: Rename metadata to “Adapter”
Updated the frontmatter title and description to use “Adapter” terminology, matching the new docs structure.
6-6: Update main heading to “Elysia Adapter”
The level-1 heading now matches the updated title, ensuring consistency.apps/content/docs/adapters/tanstack-start.md (2)
2-3: Rename metadata to “Adapter”
Frontmatter title and description correctly reflect “TanStack Start Adapter,” aligning with the consolidation.
6-6: Update main heading to “TanStack Start Adapter”
Heading update maintains consistency with the renamed document title.apps/content/docs/adapters/electron.md (2)
2-3: Rename metadata to “Adapter”
Title and description now reference “Electron Adapter,” consistent with the adapter terminology.
6-6: Update main heading to “Electron Adapter”
The H1 heading has been updated to match the new naming convention.packages/vue-query/src/general-utils.ts (1)
9-9: Updated JSDoc link to new integrations path
This change mirrors the restructure in other packages. Consider adding a link-validation step in CI to catch any broken references.apps/content/docs/adapters/svelte-kit.md (3)
2-3: Title and description updated correctly. The terminology shift from “Integration” to “Adapter” in both the title and description aligns with the PR objectives.
6-6: Main heading renamed to “Svelte Kit Adapter”: approved. Heading now matches the updated title.
8-8: Verify official framework naming. You’ve split “SvelteKit” into “Svelte Kit.” Please confirm against the framework’s branding guidelines (the official name is typically “SvelteKit”).apps/content/docs/adapters/fastify.md (2)
2-3: Title and description updated correctly. The document now uses “Fastify Adapter” and the description reflects project usage.
6-6: Main heading renamed to “Fastify Adapter”: approved. Consistent with the updated title and description.packages/nest/src/implement.ts (1)
35-35: Updated JSDoc reference URL: approved. The @see link now accurately points to the NestJS contract implementation guide at its new integrations path.apps/content/docs/adapters/solid-start.md (1)
2-3: Title and description updated to “Adapter”: approved. Reflects the standardized terminology.apps/content/docs/adapters/astro.md (2)
2-3: Title and description updated to “Adapter”: approved. Follows the updated naming conventions.
12-13: Example code grouped withcode-group: approved. Wrapping the snippet in::: code-groupimproves readability in the rendered docs.Also applies to: 31-32
apps/content/docs/adapters/express.md (2)
2-3: LGTM! Consistent terminology update.The title and description changes from "Integration" to "Adapter" align well with the PR's objective to reorganize and consolidate documentation terminology.
6-6: LGTM! Heading updated consistently.The heading change from "Express.js Integration" to "Express.js Adapter" maintains consistency with the title and description updates.
packages/hey-api/src/to-orpc-client.ts (1)
10-14:Details
✅ Verification successful
Verify documentation link consistency with reorganization.
The JSDoc addition improves documentation, but the link points to
/docs/integrations/hey-api. Since this PR reorganizes integrations into adapters, please verify if this URL should be updated to match the new documentation structure.
🏁 Script executed:
#!/bin/bash # Description: Check if the Hey API documentation has been moved to the adapters section # Expected: Find the Hey API documentation in the new location # Search for Hey API documentation files fd -t f -e md hey-api # Search for Hey API references in navigation config rg -A 5 -B 5 "hey-api" apps/content/.vitepress/config.ts || trueLength of output: 643
Documentation link is correct
The Hey API docs still reside at
/docs/integrations/hey-api(seeapps/content/docs/integrations/hey-api.mdand the VitePress nav config). No update to the JSDoc link is needed at this time.apps/content/docs/adapters/message-port.md (1)
10-14: LGTM! Consistent table updates align with reorganization.The table has been updated consistently across all environments (Electron, Browser, Worker Threads) with the new "Adapter Guide" terminology and updated URLs pointing to
/docs/adapters/. This maintains the documentation structure while reflecting the integration-to-adapter reorganization.packages/react-query/src/procedure-utils.ts (4)
23-23: LGTM! Documentation URL updated consistently.The JSDoc URL for the
callmethod has been updated to point to the new TanStack Query documentation location under/docs/integrations/tanstack-query-old/.
30-30: LGTM! Documentation URL updated consistently.The JSDoc URL for the
queryOptionsmethod has been updated to point to the new TanStack Query documentation location.
42-42: LGTM! Documentation URL updated consistently.The JSDoc URL for the
experimental_streamedOptionsmethod has been updated to point to the new TanStack Query documentation location.
62-62: LGTM! Documentation URL updated consistently.The JSDoc URL for the
mutationOptionsmethod has been updated to point to the new TanStack Query documentation location.packages/vue-query/src/procedure-utils.ts (5)
15-15: Updated documentation URL for calling procedure clients
The JSDoc link now points to the new/docs/integrations/tanstack-query-old/basic#calling-procedure-clientspath, consistent with the revised documentation structure.
22-22: Updated link for query options utility docs
The@seereference has been updated to/docs/integrations/tanstack-query-old/basic#query-options-utilityto reflect the reorganized Integrations section.
34-34: Corrected URL for streamed query options utility
The streamed query JSDoc now points to/docs/integrations/tanstack-query-old/basic#streamed-query-options-utility, matching the new sidebar grouping.
45-45: Aligned infinite query options link
Updated the infinite query options@seelink to/docs/integrations/tanstack-query-old/basic#infinite-query-options-utilityper docs reorganization.
54-54: Mutation options documentation link updated
The JSDoc link for mutation options now references/docs/integrations/tanstack-query-old/basic#mutation-options, ensuring consistency with the relocated docs.packages/svelte-query/src/procedure-utils.ts (5)
13-13: Updated documentation URL for calling procedure clients
The JSDoc link for client calls now references/docs/integrations/tanstack-query-old/basic#calling-procedure-clientsin line with the new Integrations grouping.
20-20: Query options utility link corrected
Changed the@seereference to/docs/integrations/tanstack-query-old/basic#query-options-utilityto match the reorganized nav.
32-32: Streamed query options documentation updated
The link now points to/docs/integrations/tanstack-query-old/basic#streamed-query-options-utility, aligning with the new documentation structure.
43-43: Infinite query options link corrected
Updated the infinite options@seelink to/docs/integrations/tanstack-query-old/basic#infinite-query-options-utilityfor consistency.
52-52: Mutation options docs link updated
The mutation options documentation URL now correctly references/docs/integrations/tanstack-query-old/basic#mutation-options.packages/solid-query/src/procedure-utils.ts (5)
13-13: Updated documentation URL for calling procedure clients
Adjusted the JSDoc link to/docs/integrations/tanstack-query-old/basic#calling-procedure-clientsaccording to the docs reorganization.
20-20: Query options utility link updated
The@seereference for queryOptions now points to/docs/integrations/tanstack-query-old/basic#query-options-utility.
32-32: Streamed query options documentation link corrected
Changed to/docs/integrations/tanstack-query-old/basic#streamed-query-options-utilityto align with the new structure.
43-43: Infinite query options link updated
The infiniteOptions@seenow references/docs/integrations/tanstack-query-old/basic#infinite-query-options-utility.
52-52: Mutation options documentation link adjusted
Link updated to/docs/integrations/tanstack-query-old/basic#mutation-optionsfor consistency across adapters.packages/tanstack-query/src/procedure-utils.ts (5)
27-27: Updated documentation URL for calling procedure clients
The JSDoc link now correctly points to/docs/integrations/tanstack-query-old/basic#calling-procedure-clientsmatching the new Integrations section.
34-34: Query options utility docs link updated
Changed the@seereference for queryOptions to/docs/integrations/tanstack-query-old/basic#query-options-utility.
46-46: Streamed query options documentation link corrected
Updated to/docs/integrations/tanstack-query-old/basic#streamed-query-options-utilityin line with sidebar restructuring.
57-57: Infinite query options link updated
The infiniteOptions JSDoc now references/docs/integrations/tanstack-query-old/basic#infinite-query-options-utility.
66-66: Mutation options documentation link updated
MutationOptions JSDoc link has been updated to/docs/integrations/tanstack-query-old/basic#mutation-optionsfor consistency.apps/content/docs/comparison.md (3)
20-24: Consolidated Tanstack Query integration links updated
The entries for React, Vue, Solid, Svelte, and Angular now all point to/docs/integrations/tanstack-query, aligning the comparison table with the unified Integrations section.
25-25: Updated Vue Pinia Colada integration link
The Vue Pinia Colada integration link has been updated to/docs/integrations/pinia-coladato match the new documentation structure.
39-39: Updated Nest.js integration link
Changed the Nest.js integration link to/docs/openapi/integrations/implement-contract-in-nestfor consistency with the OpenAPI Integrations section.apps/content/.vitepress/config.ts (4)
211-215: Approve the OpenAPI sidebar reorganization.The renaming from "NestJS" to "Integrations" in the OpenAPI sidebar provides better semantic organization and allows for future expansion of OpenAPI-related integrations.
91-106:Details
✅ Verification successful
Validate that all adapter documentation paths exist.
The reorganization adds many new adapter links. Ensure all referenced documentation files exist at their specified paths.
🏁 Script executed:
#!/bin/bash # Description: Verify all adapter documentation files exist # Expected: All adapter docs should be present echo "Checking adapter documentation files..." adapter_paths=( "apps/content/docs/adapters/astro.md" "apps/content/docs/adapters/browser.md" "apps/content/docs/adapters/electron.md" "apps/content/docs/adapters/elysia.md" "apps/content/docs/adapters/express.md" "apps/content/docs/adapters/fastify.md" "apps/content/docs/adapters/hono.md" "apps/content/docs/adapters/next.md" "apps/content/docs/adapters/nuxt.md" "apps/content/docs/adapters/react-native.md" "apps/content/docs/adapters/remix.md" "apps/content/docs/adapters/solid-start.md" "apps/content/docs/adapters/svelte-kit.md" "apps/content/docs/adapters/tanstack-start.md" "apps/content/docs/adapters/worker-threads.md" ) missing_files=() for path in "${adapter_paths[@]}"; do if [[ ! -f "$path" ]]; then missing_files+=("$path") fi done if [[ ${#missing_files[@]} -eq 0 ]]; then echo "✅ All adapter documentation files exist" else echo "❌ Missing adapter documentation files:" printf '%s\n' "${missing_files[@]}" fiLength of output: 2161
All adapter documentation paths verified
✅ All adapter docs exist underapps/content/docs/adaptersas referenced.
152-152:Details
✅ Verification successful
Verify cross-reference consistency for NestJS integration.
The NestJS integration links to OpenAPI documentation (
/docs/openapi/integrations/implement-contract-in-nest) rather than a dedicated integration page. Ensure this cross-reference is intentional and the target exists.
🏁 Script executed:
#!/bin/bash # Description: Verify NestJS integration documentation exists and check for consistency # Expected: The OpenAPI integration file should exist target_file="apps/content/docs/openapi/integrations/implement-contract-in-nest.md" if [[ -f "$target_file" ]]; then echo "✅ NestJS integration documentation exists at: $target_file" echo -e "\nContent preview:" head -10 "$target_file" else echo "❌ Missing NestJS integration documentation at: $target_file" fi # Check if there are any other NestJS-related docs that might be duplicated echo -e "\nSearching for other NestJS documentation..." fd -e md . apps/content/docs/ | xargs grep -l -i "nestjs" | head -5Length of output: 1139
Cross-reference confirmed: NestJS integration documentation exists
- Verified that
apps/content/docs/openapi/integrations/implement-contract-in-nest.mdis present and correctly titled “Implement Contract in NestJS.”- No other NestJS-related markdown files were found that would cause duplication or inconsistency.
135-153:Details
❓ Verification inconclusive
Validate integration documentation paths and verify content consistency.
The section has been renamed from "Tanstack Query" to "Integrations" with significant restructuring. Ensure all new paths exist and content is properly organized.
🏁 Script executed:
#!/bin/bash # Description: Verify all integration documentation files exist # Expected: All integration docs should be present at new paths echo "Checking integration documentation files..." integration_paths=( "apps/content/docs/integrations/tanstack-query.md" "apps/content/docs/integrations/tanstack-query-old/basic.md" "apps/content/docs/integrations/tanstack-query-old/react.md" "apps/content/docs/integrations/tanstack-query-old/vue.md" "apps/content/docs/integrations/tanstack-query-old/solid.md" "apps/content/docs/integrations/tanstack-query-old/svelte.md" "apps/content/docs/integrations/pinia-colada.md" "apps/content/docs/integrations/hey-api.md" ) missing_files=() for path in "${integration_paths[@]}"; do if [[ ! -f "$path" ]]; then missing_files+=("$path") fi done if [[ ${#missing_files[@]} -eq 0 ]]; then echo "✅ All integration documentation files exist" else echo "❌ Missing integration documentation files:" printf '%s\n' "${missing_files[@]}" fi # Check if old Tanstack Query paths were moved/renamed echo -e "\nChecking for old Tanstack Query documentation..." fd -e md . apps/content/docs/ | grep -i tanstack | head -10Length of output: 2117
All integration documentation paths are valid
Verified that every file referenced in
apps/content/.vitepress/config.tsexists underapps/content/docs/integrations/(including thetanstack-query(-old)tree, Pinia Colada, and Hey API). Links in the sidebar configuration will resolve correctly.• No missing Markdown files for integrations
• Sidebar paths match the actual file locationsPlease manually review each document’s structure, headings, and examples to ensure the content is organized and consistent with the new “Integrations” layout.
1 participant
Summary by CodeRabbit