hasura / ddn-docs

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

add tracking ids to quickstart steps #615

Closed rikinsk closed 1 month ago

rikinsk commented 1 month ago

Description 📝

adds data-attr param to quickstart steps and copy buttons to be able to track what commands are being copied

Quick Links 🚀

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

The addition of unique IDs to each step in the quickstart is a beneficial change for identifying the steps programmatically and for potential future improvements like deep linking or tracking. However, you should ensure that the inclusion of 'data-attr' attributes meets accessibility standards and doesn't negatively impact screen readers or other assistive technologies. Ensure also that 'id' values are descriptive and consistent.

✅ Integrated

The added 'id' properties integrate well with the existing codebase, and will likely enhance the overall usability of the documentation by providing anchors for direct links and potentially enabling enhanced interaction through scripts. Ensure the rest of the documentation follows a consistent approach to aid coherence and usability.

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

Deploying v3-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: fd185d7
Status: ✅  Deploy successful!
Preview URL: https://6d5121f8.v3-docs-eny.pages.dev
Branch Preview URL: https://rikinsk-add-tracking.v3-docs-eny.pages.dev

View logs