Closed seanparkross closed 3 weeks 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:
The PR content is well-organized and detailed, introducing the concept of federation, providing actual commands for building supergraphs and subgraphs, explaining cross-repo relationships, and guiding users on independent subgraph development. The architecture.mdx
file is particularly informative, offering substantial insight into federation architecture and its benefits, which aligns with the usability assertion. The addition of visual aids, such as the Thumbnail component with an image (whole-supergraph-erd.png
), enhances comprehension.
The PR integrates new federation content effectively with the rest of the documentation. It extends the sidebar (_category_.json
) to include a dedicated section for Federation with an associated icon, suggesting that these documents are part of a coherent module within the larger structure. The content's addition seems to fill a previous gap in the documentation by providing a comprehensive guide to data federation that likely did not exist in such an integrated form before. The documents are well-positioned (e.g., sidebar_position
) to create a logical flow of information and the .mdx
files' metadata includes SEO front matter, thus improving the discoverability and usability of the documentation.
Latest commit: |
88d41ba
|
Status: | ✅ Deploy successful! |
Preview URL: | https://1104c94f.v3-docs-eny.pages.dev |
Branch Preview URL: | https://top-level-federation-section.v3-docs-eny.pages.dev |
Images automagically compressed by Calibre's image-actions ✨
Compression reduced images by 21.7%, saving 30.76 KB.
Filename | Before | After | Improvement | Visual comparison |
---|---|---|---|---|
static/img/federation/whole-supergraph-erd.png |
141.75 KB | 110.99 KB | -21.7% | View diff |
177 images did not require optimisation.
Images automagically compressed by Calibre's image-actions ✨
Compression reduced images by 15.8%, saving 24.20 KB.
Filename | Before | After | Improvement | Visual comparison |
---|---|---|---|---|
static/img/federation/whole-supergraph-erd.png |
153.46 KB | 129.26 KB | -15.8% | View diff |
187 images did not require optimisation.
Description 📝
New top level federation section with Overview, Architecture, Git Workflows, Cross-repo Relationships, Independent Subgraph Development, Subgraph Prefixing, build commands
Quick Links 🚀
Federation Overview
Assertion Tests 🤖
Adds a new top level federation section to help users understand the data federation concepts and workflows.