hasura / ddn-docs

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

update project dir structure docs #644

Closed rikinsk closed 1 month ago

rikinsk commented 1 month ago

Description 📝

Quick Links 🚀

https://rikinsk-update-project-confi.v3-docs-eny.pages.dev/project-configuration/config

Assertion Tests 🤖

hasura-bot commented 1 month ago

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

hasura-bot commented 1 month ago

DX: Assertion Testing

❌ Diff

While the change in sidebar label from 'Configuration' to 'Directory structure' clarifies the content focus, the diff shows removed details on Hasura CLI, build profiles, and subgraphs without context on where this information can now be found. The introduction reduction lacks a transitionary text for users familiar with the previous content. It would be beneficial to reference where to find the previous content if it has been relocated.

✅ Integrated

The integration of the PR provides a focused and detailed contribution to the overall usability. It provides a comprehensive view of the directory structure, with clear tables for file types and directories along with their descriptions, making it easy for users to understand the project setup. The sample project directory structure is visually organized and, alongside the expanded sections on file types and directories, contributes positively to the document's structure and clarity, increasing usability.

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

Deploying v3-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 57d81b0
Status: ✅  Deploy successful!
Preview URL: https://f26f9844.v3-docs-eny.pages.dev
Branch Preview URL: https://rikinsk-update-project-confi.v3-docs-eny.pages.dev

View logs