search

hasura / ddn-docs

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

Update CLI docs #640

Closed rikinsk closed 1 month ago

rikinsk commented 1 month ago

Description 📝

Update CLI docs to the latest

Quick Links 🚀

Assertion Tests 🤖

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

Deploying v3-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 2bcd47f
Status: ✅  Deploy successful!
Preview URL: https://fe0a803e.v3-docs-eny.pages.dev
Branch Preview URL: https://rikinsk-update-cli-docs.v3-docs-eny.pages.dev

View logs

hasura-bot commented 1 month ago

DX: Assertion Testing

✅ Diff

The changes made in the PR are clear and consistent across files. The addition of the --dir <project-dir> flag in the codemod upgrade commands provides necessary specificity for the operation's context. The adjustment of ddn_run's description to include 'config' adds clarity. The reordering of keys in ddn_context_set aligns better with other indications of priority or workflow in CLI operations. The update in ddn_connector-link and ddn_connector-link_update from 'Introspect the Connector' to 'Fetch NDC details from the Connector' clarifies the action being performed by the command.

✅ Integrated

The PR integrates well with the existing files, and the changes are consistent with the overall usability of the documentation. By providing necessary clarity and specificity in command descriptions, as well as harmonizing the order of operations, the modifications contribute positively to user understanding. The addition of the 'run' command in the index file helps maintain a complete list of operations, which is essential for intuitive usability. Overall, the PR maintains the integrity of the documentation and enhances the user's ability to effectively engage with the CLI features.