hasura / ddn-docs

Repository for the Hasura DDN version of docs
https://hasura.io/docs
2 stars 6 forks source link

docs: improve nested field filtering and add relationship comparison performance #610

Closed rakeshkky closed 1 month ago

rakeshkky commented 1 month ago

Description 📝

Quick Links 🚀

Assertion Tests 🤖

linear[bot] commented 1 month ago
APIPG-872 Docs: Bypass NDC relation_comparisons capability in boolean expressions

* Document this enhancement in relationship comparisons * Reference to the compatibility date * Performance implication (add trace references)

hasura-bot commented 1 month ago

DX: Assertion Testing

✅ Diff

The updates to documentation include clarification of terms, such as changing 'Filter based on fields of nested objects' to 'Filter based on nested fields', which makes the titles more concise and easier to understand. The expansion of examples to include filtering based on object and array relationships adds clarity. Adding information on the data connector capability provides necessary context for understanding performance implications. Overall, the changes improve the specificity and clarity of the documentation.

✅ Integrated

The changes integrate well into the overall documentation structure, improving its usability by being more precise and informative on diverse use cases of relationship filtering. The new additions do not disrupt the pre-existing order but instead enhance the learning flow, offering a seamless transition from basic to advanced topics. This ensures that readers can gradually build their knowledge without being overwhelmed. The new file 'performance-relationship-comparisons.mdx' adds valuable insights into performance considerations, completing the narrative on querying effectively with nested fields.

cloudflare-workers-and-pages[bot] commented 1 month ago

Deploying v3-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 72e2af1
Status: ✅  Deploy successful!
Preview URL: https://f26255bf.v3-docs-eny.pages.dev
Branch Preview URL: https://rakeshkky-apipg-872-docs-byp.v3-docs-eny.pages.dev

View logs

hasura-bot commented 1 month ago

Hey, @rakeshkky :wave:

Thanks for this PR! Since you changed docs files, our automated Action assigned Sean as your reviewer :tada:

Before Sean looks over the changes, we ask you to take care of a couple of items:

The docs team aims to get all PRs reviewed within 48 hours of your team doing a review in the form of a content pass. Let Sean know the level of urgency on Slack :+1: