Closed robertjdominguez closed 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:
The PR generally improves readability by fixing inconsistencies in formatting and removing unnecessary visual clutter. Splitting long paragraphs into multiple lines makes it easier to track future changes to the text. However, ensure to maintain consistency in format for code snippets across the document.
While the individual edits improve readability, the PR lacks context on how the new steps, like the metadata validation and subgraph deployment, integrate with the existing workflow steps. Further clarification on how these new steps fit into the workflow is needed to ensure the overall usability and comprehensibility of the documentation are maintained. Moreover, the text 'the UX team can also add relationships and permissions in their that integrate with the Fulfillment team's existing subgraphs too' seems incomplete and requires rephrasing for clarity. Adding examples or a description of these specific steps would improve the documentation's usefulness for new collaborators.
Latest commit: |
7d91fdf
|
Status: | ✅ Deploy successful! |
Preview URL: | https://765d0117.v3-docs-eny.pages.dev |
Branch Preview URL: | https://rob-docs-clarify-subgraph-bu.v3-docs-eny.pages.dev |
Description 📝
Fixes subgraph build steps by adding clearer instructions and calling out what each step does.
Previously, we were condensing two steps into one; this clearly calls out that Step 7 validates metadata before a user is then required to create a new build of the subgraph with the latest applied metadata (or whatever build ID they wish) on Hasura Cloud.
Context via Slack
Quick Links 🚀
Onboard Teams
Assertion Tests 🤖