hasura / ddn-docs

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

Docs: Update basics section #589

Closed robertjdominguez closed 1 month ago

robertjdominguez commented 1 month ago

Description 📝

Updates the Basics section to have an easier-to-read overview with less bullets and simpler language. Additionally, the Background page's headings have been modified for easier grokking in the right-hand TOC.

Quick Links 🚀

Basics Overview

Assertion Tests 🤖

A user should be able to generally understand what Hasura DDN is and why we built it.

hasura-bot commented 1 month ago

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

hasura-bot commented 1 month ago

DX: Assertion Testing

✅ Diff

The changes in the PR enhance clarity by streamlining the content structure. The use of consistent heading levels for API Authors, Maintainers, and Consumers improves the document's skimmability. The author has successfully condensed the information in overview.mdx, making it more succinct and focused on the value proposition of Hasura DDN.

✅ Integrated

The PR effectively integrates with the larger document by maintaining a high-level perspective on what Hasura DDN is and its benefits, while leaving more detailed explanations to other sections. It preserves the narrative of revolutionizing product development experience and simplifies the previous detailed list into a more approachable, high-level overview. The added link to learn more about the data supergraph is a good touch for users new to the concept.

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

Deploying v3-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: dd2e34b
Status: ✅  Deploy successful!
Preview URL: https://b8560e65.v3-docs-eny.pages.dev
Branch Preview URL: https://rob-docs-simplify-basics-sec.v3-docs-eny.pages.dev

View logs