Skip to content

User-First Query Records Documentation#86

Merged
Sendipad merged 3 commits into
developfrom
jules/query-records-user-docs-5709570322277507465
Jul 5, 2026
Merged

User-First Query Records Documentation#86
Sendipad merged 3 commits into
developfrom
jules/query-records-user-docs-5709570322277507465

Conversation

@abdoruzaqi

Copy link
Copy Markdown
Collaborator

This PR provides a complete overhaul of the Query Records documentation, transitioning from technical descriptions to user-first, outcome-oriented guides.

Key changes include:

  • Simplified Language: Replaced technical jargon with business-centric terms (e.g., "Blocks" instead of "Nodes", "Tables" instead of "DocTypes").
  • Mode-Specific Pages: Individual pages for each of the 10 supported query modes, helping users choose the right tool for their specific business needs.
  • Performance Benefits: Explained performance considerations as direct user benefits (faster rules, reduced system load) and highlighted built-in optimizations like Smart Caching and Direct Math (pushdown).
  • Practical Examples: Every mode includes a real-world scenario (e.g., credit limit checks, overdue reminders, budget verification) to ground the features in actual usage.
  • Metadata Integrity: Maintained the repository's documentation framework by preserving essential frontmatter metadata used for site organization.

PR created automatically by Jules for task 5709570322277507465 started by @abdoruzaqi

- Updated Query Records index with business-focused overview and mode selection guide.
- Created/Updated detailed guides for all 10 query modes (List, Doc, Exist, Report, Count, Sum, Average, Min/Max, Group By).
- Incorporated non-technical performance guidance highlighting automatic optimizations like caching and aggregation pushdown.
- Restored functional frontmatter metadata to ensure proper site indexing.
- Added realistic ERPNext/Frappe business examples for each mode.
@google-labs-jules

Copy link
Copy Markdown
Contributor

👋 Jules, reporting for duty! I'm here to lend a hand with this pull request.

When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down.

I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job!

For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with @jules. You can find this option in the Pull Request section of your global Jules UI settings. You can always switch back!

New to Jules? Learn more at jules.google/docs.


For security, I will only act on instructions from the user who triggered this task.

- Refactored all query mode pages to follow a strict 6-section template.
- Unified nomenclature for "Exist Record" and "Query Doc" strategies.
- Centralized the "Performance Model" in the Query Records index.
- Added critical safety warnings for caching (stale data) and reports (black-box execution).
- Neutralized marketing-heavy tone to a more credible, professional standard.
- Standardized the "Group By" output schema description.
- Restored essential frontmatter metadata for site indexing.
- Defined Query Records as a read-only data access layer for rule execution.
- Explicitly documented the "Read-Only" core principle (no data mutation).
- Clarified downstream consumption by Check, Loop, and Assignment blocks.
- Refactored all 9 query mode pages to follow a strict 6-section template.
- Unified nomenclature for "Exist Record" and "Query Doc" strategies.
- Centralized the "Performance Model" in the Query Records index.
- Added critical safety warnings for caching (stale data) and reports (black-box execution).
- Standardized the "Group By" output schema description.
- Restored essential frontmatter metadata for site indexing.
@Sendipad Sendipad merged commit 30c3fa0 into develop Jul 5, 2026
2 checks passed
@Sendipad Sendipad deleted the jules/query-records-user-docs-5709570322277507465 branch July 5, 2026 22: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.

2 participants