hasura / ddn-docs

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

update metadata docs #539

Closed rikinsk closed 2 months ago

rikinsk commented 2 months ago

Description

Update metadata docs to latest

Note:

these were fixed manually at the moment

Quick Links 🚀

https://rikinsk-update-metadata-docs.v3-docs-eny.pages.dev/supergraph-modeling/overview/

🤖 DX: Assertion Tests

robertjdominguez commented 2 months ago

Hey, @rikinsk :wave:

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

Before Rob 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 Rob know the level of urgency on Slack :+1:

robertjdominguez commented 2 months ago

DX: Assertion Testing

✅ Diff

The PR diff indicates some thoughtful changes such as improved clarity on the definition of GraphQlTypeName, addition of examples to illustrate scenarios, and a new section on 'DataConnectorScalarType' for better type mapping which improves the documentation from a technical standpoint. Moreover, the inclusion of 'NoAuth' config with a detailed example in the 'AuthConfig' section is a notable improvement. The usage of consistent naming convention like [AuthConfig2](#authconfig-authconfig2) helps maintain readability and navigation within the document.

✅ Integrated

When reviewing the integrated changes alongside the entire document, the PR's contributions enhance the overall usability of the documentation. The newly added details, such as clarifications on 'ModelAggregateGraphQlDefinition', don't seem to disrupt the flow and instead complement the existing structure by filling in informational gaps. The inclusion of 'NoAuthConfig' and associated 'Example' sections for 'AuthConfig' enriches the documentation with clearer, practical configurations that users can readily apply. The added 'DataConnectorScalarType' aligns well within the 'AggregateExpressions' context, providing valuable type-specific details which users would expect in this section.

cloudflare-workers-and-pages[bot] commented 2 months ago

Deploying v3-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 379c7c8
Status: ✅  Deploy successful!
Preview URL: https://bd1e1051.v3-docs-eny.pages.dev
Branch Preview URL: https://rikinsk-update-metadata-docs.v3-docs-eny.pages.dev

View logs