Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs for infinite queries #4820

Merged

Conversation

markerikson
Copy link
Collaborator

@markerikson markerikson commented Jan 17, 2025

This PR:

  • Documents infinite query endpoints and infiniteQueryOptions inside of createApi
  • Documents the generated React hooks
  • Adds an "Infinite Queries" usage guide page
  • Makes our use of build consistent instead of mixed with builder
  • Restructures the "React Hooks" API ref page:
    • grouped the hooks by category ("primary", "secondary", and "implementation)
    • moved the description content up for each hook to be above the signature
    • reworked the "what hooks are generated?" layout in the "Overview" section
  • Adds sub-categories to the "Using RTKQ" section ("Standard Usage", "Common Use Cases", "Advanced Use Cases")

Copy link

codesandbox bot commented Jan 17, 2025

Review or Edit in CodeSandbox

Open the branch in Web EditorVS CodeInsiders

Open Preview

@markerikson markerikson changed the title Show more docs headers Add docs for infinite queries Jan 17, 2025
Copy link

codesandbox-ci bot commented Jan 17, 2025

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 46c922a:

Sandbox Source
@examples-query-react/basic Configuration
@examples-query-react/advanced Configuration
@examples-action-listener/counter Configuration
rtk-esm-cra Configuration

Copy link

github-actions bot commented Jan 17, 2025

size-limit report 📦

Path Size

@markerikson markerikson force-pushed the feature/infinite-query-docs branch from 40568c1 to b873043 Compare January 19, 2025 21:24
@markerikson markerikson force-pushed the feature/infinite-query-docs branch from 4e9b7cf to f5aaa4f Compare January 20, 2025 20:16
Copy link

netlify bot commented Jan 20, 2025

Deploy Preview for redux-starter-kit-docs ready!

Name Link
🔨 Latest commit 46c922a
🔍 Latest deploy log https://app.netlify.com/sites/redux-starter-kit-docs/deploys/678eb4d22074ca00086f7bae
😎 Deploy Preview https://deploy-preview-4820--redux-starter-kit-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@markerikson markerikson marked this pull request as ready for review January 20, 2025 20:51
@markerikson markerikson merged commit ef90600 into feature/infinite-query-integration Jan 20, 2025
88 checks passed
@aryaemami59 aryaemami59 deleted the feature/infinite-query-docs branch January 20, 2025 23:32
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.

1 participant