Enhance model/command visualisation docs

hasura / ddn-docs

Repository for the Hasura DDN version of docs

https://hasura.io/docs

2 stars 6 forks source link

Enhance model/command visualisation docs #596

Closed Varun-Choudhary closed 1 month ago

Varun-Choudhary commented 1 month ago

Description 📝

This PR enhance the docs for model/command visualisations. It adds sub-sections for relevant items under model/command visualisation.

Quick Links 🚀

Assertion Tests 🤖

linear[bot] commented 1 month ago

CON-57 Add new docs

1. Add new docs for the explorer tab which includes relationships, permissions, fields, graphic root field and signature.

hasura-bot commented 1 month ago

Hey, @Varun-Choudhary :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:

[ ] Make sure you've checked over our PR guide on the wiki. It ensures you've done your due diligence on the basics: spelling, heading casings, etc.
[ ] Rob will need a review from someone on your team to ensure your team-specific content is accurate. Once that's done, ping Rob on Slack, and he'll give a docs review :fire:
[ ] Additionally, please check this box to confirm your feature works as expected when using the documentation you've written. This is critical to ensuring our users have the information they need.

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:

hasura-bot commented 1 month ago

DX: Assertion Testing

✅ Diff

The additions in the PR provide comprehensive details about models, commands, GraphQL root fields, output fields, relationships, and permissions, which enhances the clarity and understandability of the concepts. The incorporation of visual aids with Thumbnails improves the visual appeal and helps users to quickly grasp the structure and use of the API.

✅ Integrated

The integration of new content within the existing documentation appears seamless and maintains consistency in formatting and style. The expanded sections are logically placed following the introduction to the console's visualization features, offering a deeper dive into specific aspects of the supergraph. This serves to enrich the overall usability by giving users practical insights alongside the higher-level overview previously provided.

hasura-bot commented 1 month ago

Images automagically compressed by Calibre's image-actions ✨

Compression reduced images by 48.2%, saving 116.70 KB.

Filename	Before	After	Improvement	Visual comparison
`static/img/get-started/fields.png`	83.69 KB	44.25 KB	-47.1%	View diff
`static/img/get-started/graphql-root-field-and-signature.png`	72.06 KB	38.44 KB	-46.7%	View diff
`static/img/get-started/permissions.png`	45.26 KB	22.81 KB	-49.6%	View diff
`static/img/get-started/relationships.png`	41.27 KB	20.08 KB	-51.3%	View diff

169 images did not require optimisation.

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

Deploying v3-docs with Cloudflare Pages

Latest commit:	`df91ae0`
Status:	✅ Deploy successful!
Preview URL:	https://f3961378.v3-docs-eny.pages.dev
Branch Preview URL:	https://varun-con-57.v3-docs-eny.pages.dev

View logs

hasura-bot commented 1 month ago

Images automagically compressed by Calibre's image-actions ✨

Compression reduced images by 51.3%, saving 52.17 KB.

Filename	Before	After	Improvement	Visual comparison
`static/img/get-started/command-signature.png`	25.55 KB	11.17 KB	-56.3%	View diff
`static/img/get-started/graphql-root-field.png`	52.08 KB	28.27 KB	-45.7%	View diff
`static/img/get-started/model-signature.png`	24.12 KB	10.14 KB	-58.0%	View diff

172 images did not require optimisation.