docs: Improve queries documentation - add TIL section, reduce duplication, clarify approach selection
This PR addresses the documentation review request for queries by improving organization, reducing duplication, and providing clearer guidance on when to use different query approaches.
Key Changes
Added TIL (Today I Learned) Section
Added a prominent TIL section to the main queries guide that clearly explains when to use each approach:
-
useQuery()- Great for getting started and simple use cases -
defineQueryOptions()- Allows fully typed cache operations, preferred for maintainability -
defineQuery()- Creates a mini store for state reuse across components
Reduced Documentation Duplication
- Simplified property explanations in
quick-start.mdto avoid repeating detailed information fromqueries.md - Removed duplicated status table and detailed property descriptions from quick-start
- Added cross-references between documents for better navigation
Improved Learning Progression
- Restructured the "Organizing Queries" section to show clear progression from simple to advanced patterns
- Added "Next Steps" section in quick-start to guide users toward more advanced patterns
- Made recommendations more explicit about preferred approaches for production use
Fixed Outstanding Issues
- Resolved TODO in
reusable-queries.mdaboutdefineQueryOptions() - Added clear comparison between
defineQueryOptions()anddefineQuery() - Updated guidance to recommend
defineQueryOptions()for most organized query scenarios
Enhanced Consistency
- Aligned messaging across all documentation files about when to use each approach
- Updated cross-references to point to the correct sections
- Ensured consistent terminology throughout
The documentation now provides a clear learning path from basic useQuery() usage to advanced patterns while eliminating confusion about which approach to choose for different scenarios.
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.
Deploy Preview for funny-banoffee-0afb46 ready!
| Name | Link |
|---|---|
| Latest commit | 57a7538c04a2496bd4a580837af109252ce4c1e4 |
| Latest deploy log | https://app.netlify.com/projects/funny-banoffee-0afb46/deploys/68905b2930aeb000081993f8 |
| Deploy Preview | https://deploy-preview-354--funny-banoffee-0afb46.netlify.app |
| Preview on mobile | Toggle QR Code...Use your smartphone camera to open QR code link. |
To edit notification comments on pull requests, go to your Netlify project configuration.
[!IMPORTANT]
Review skipped
Bot user detected.
To trigger a single review, invoke the
@coderabbitai reviewcommand.You can disable this status message by setting the
reviews.review_statustofalsein the CodeRabbit configuration file.
[!NOTE]
Free review on us!
CodeRabbit is offering free reviews until Tue Aug 05 2025 to showcase some of the refinements we've made.
🪧 Tips
Chat
There are 3 ways to chat with CodeRabbit:
- Review comments: Directly reply to a review comment made by CodeRabbit. Example:
-
I pushed a fix in commit <commit_id>, please review it. -
Explain this complex logic. -
Open a follow-up GitHub issue for this discussion.
-
- Files and specific lines of code (under the "Files changed" tab): Tag
@coderabbitaiin a new review comment at the desired location with your query. Examples:-
@coderabbitai explain this code block.
-
- PR comments: Tag
@coderabbitaiin a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:-
@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase. -
@coderabbitai read src/utils.ts and explain its main purpose. -
@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
-
Support
Need help? Create a ticket on our support page for assistance with any issues or questions.
CodeRabbit Commands (Invoked using PR comments)
-
@coderabbitai pauseto pause the reviews on a PR. -
@coderabbitai resumeto resume the paused reviews. -
@coderabbitai reviewto trigger an incremental review. This is useful when automatic reviews are disabled for the repository. -
@coderabbitai full reviewto do a full review from scratch and review all the files again. -
@coderabbitai summaryto regenerate the summary of the PR. -
@coderabbitai generate sequence diagramto generate a sequence diagram of the changes in this PR. -
@coderabbitai resolveresolve all the CodeRabbit review comments. -
@coderabbitai configurationto show the current CodeRabbit configuration for the repository. -
@coderabbitai helpto get help.
Other keywords and placeholders
- Add
@coderabbitai ignoreanywhere in the PR description to prevent this PR from being reviewed. - Add
@coderabbitai summaryto generate the high-level summary at a specific location in the PR description. - Add
@coderabbitaianywhere in the PR title to generate the title automatically.
CodeRabbit Configuration File (.coderabbit.yaml)
- You can programmatically configure CodeRabbit by adding a
.coderabbit.yamlfile to the root of your repository. - Please see the configuration documentation for more information.
- If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation:
# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
Documentation and Community
- Visit our Documentation for detailed information on how to use CodeRabbit.
- Join our Discord Community to get help, request features, and share feedback.
- Follow us on X/Twitter for updates and announcements.