Document layout.api-reference-layout - #6596
Open
devin-ai-integration[bot] wants to merge 1 commit into
Open
Conversation
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Contributor
Author
🤖 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:
|
5 tasks
Contributor
|
🌿 Preview your docs: https://fern-preview-devin-1786478198-api-reference-layout.docs.buildwithfern.com/learn Here are the markdown pages you've updated: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documents the new site-level
layout.api-reference-layoutkey, which selects how nested object fields render in the API Reference:indented(default, connector-line tree with a path breadcrumb per level) orcards(the previous bordered-card nesting).Two edits:
navigation/site-level-settings.mdx— canonical<ParamField>for the key, plus the key in thelayoutexample block.api-references/customize-api-ref.mdx— short Nested object fields section pointing at the canonical field, since a reader customizing the API Reference is the one most likely to want the opt-out.Depends on the implementation PRs, so this should land after them:
indented)fern-api/fernPR)No changelog entry here — the feature isn't shipped yet; worth adding one with the release.
Link to Devin session: https://app.devin.ai/sessions/1f176e5bc4fc49f480e0be1183283042