Make Generate [x] Reference pages consistent and consolidate layout docs#3656
Make Generate [x] Reference pages consistent and consolidate layout docs#3656devin-ai-integration[bot] wants to merge 8 commits intomainfrom
Conversation
…ink to Customize page
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
|
|
||
| ### Include more than one webhook reference | ||
| To include multiple webhook definitions in your documentation, use the `api-name` property: | ||
| ### Include more than one Webhook Reference |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Headings] 'Include more than one Webhook Reference' should use sentence-style capitalization.
|
🌿 Preview your docs: https://fern-preview-90200ad9-a8a9-477e-8f2e-9be4290257c8.docs.buildwithfern.com/learn Here are the markdown pages you've updated: |
| You can reference an operation using the format `operation: OPERATION_TYPE operationName`. See [GraphQL layout customization](/learn/docs/api-references/generate-graphql-ref#customize-the-layout) for more details. | ||
| Reference individual GraphQL operations using the `operation` keyword with the format `OPERATION_TYPE operationName`, where `OPERATION_TYPE` is `QUERY`, `MUTATION`, or `SUBSCRIPTION`. You can also set a custom `title`, `slug`, or `availability` on each operation. | ||
|
|
||
| If your schema includes operations that share the same name across different namespaces, use dot notation to disambiguate (e.g., `QUERY admin.getPlant`). |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Acronyms] 'QUERY' has no definition.
| - api: API Reference | ||
| layout: | ||
| - user: | ||
| - operation: QUERY getUser |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Acronyms] 'QUERY' has no definition.
| - GET /plants | ||
| - WSS /plants/live-updates | ||
| - WSS /plants/growth-monitor | ||
| - operation: QUERY admin.getPlant |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Acronyms] 'QUERY' has no definition.
| - WSS /plants/live-updates | ||
| - WSS /plants/growth-monitor | ||
| - operation: QUERY admin.getPlant | ||
| - operation: QUERY public.getPlant |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Acronyms] 'QUERY' has no definition.
| layout: | ||
| - section: Plants | ||
| contents: | ||
| - operation: QUERY getPlant |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Acronyms] 'QUERY' has no definition.
devin-ai-integration
bot
changed the title
1 participant
Make Generate [x] Reference pages consistent and consolidate layout docs
Summary
Restructures all five "Generate [x] Reference" pages to follow a consistent pattern and consolidates GraphQL layout customization into the Customize API Reference layout page.
Each Generate page now follows this structure:
<Steps>with three steps: "Set up your project structure", "Add the [X] Reference to your navigation", and "Customize the layout" (linking to the Customize page)<Files>directory tree anddocs.ymlsnippetKey changes per page:
<Files>tree for multi-webhook setup. Fixed broken relative links to use absolute/learn/paths.<CodeBlock>+ layout example with Steps pattern. Added new "Include more than one WebSocket Reference" section with<Files>tree.<CodeBlock>with Steps pattern. Added missing link to Customize page. Added new "Include more than one OpenRPC Reference" section with<Files>tree.<CodeBlock>with Steps pattern. Added<Files>tree for multi-GraphQL setup. Moved all layout customization content (operation syntax, namespacing, grouping, styling, hiding, sections) to the Customize page.generate-webhook-reference→generate-webhook-ref). Converted directory tree to<Files>component. Added "Customize the layout" step.docs.yml. Removed a duplicate WebSocket tab from "Ordering section contents".Review & Testing Checklist for Human
<Warning>in the availability section states that GraphQL operations can setavailabilityper-operation indocs.yml, unlike REST/Fern Definition endpoints. Confirm this is actually how Fern behaves.operation: QUERY ...,operation: MUTATION ...,operation: SUBSCRIPTION ...) matches actual Fern behavior for each context.#customize-the-layoutand#graphql-specific-layout-optionsanchors were removed. Search for any pages or external sites that still link to these.api-nameworks the same way for AsyncAPI/OpenRPC specs as it does for REST/Webhook/GraphQL.<Steps>components and<Files>trees render properly on each page, and that the new GraphQL tabs in the Customize page display correctly.Notes