hasura / ddn-docs

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

New Top Level Recipes #621

Closed seanparkross closed 1 month ago

seanparkross commented 1 month ago

Description 📝

Adds a recipe section with a single recipe for using JWTs with Auth0. A few notes:

Quick Links 🚀

New recipe section 👨‍🍳

hasura-bot commented 1 month ago

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

The author has done a good job in following documentation structure, including relevant information like prerequisites, configuration steps, and testing. The language is clear and the explanation appears complete. References to existing documentation are helpful for users needing additional context. The use of sidebar_position, which helps in maintaining the order of items, is appreciated. Also, the inclusion of a warning for users about active development is thoughtful. However, it is noted that a TODO comment for 'Add screenshot' is present, which should be addressed before the final merge. Additionally, consider updating the seoFrontMatterUpdated flag if appropriate SEO front matter has been added.

✅ Integrated

The PR integrates seamlessly into the existing documentation architecture. The addition of a new Recipes category with the correct JSON configuration and the inclusion of the Auth0 recipe demonstrates a comprehensive understanding of the documentation layout. Updating the 'utils.js' file to include a new Recipe icon shows attention to detailed documentation design. The integration of the new recipe does not disrupt the existing structure and even contributes positively to the overall usability by expanding the offerings under the Recipes section. Please ensure that the beaker icon SVG file is consistent in style and color with the existing icons for visual harmony.

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

Deploying v3-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 5f6d6ac
Status:⚡️  Build in progress...

View logs