Skip to content

Document layout.api-reference-layout - #6596

Open
devin-ai-integration[bot] wants to merge 1 commit into
mainfrom
devin/1786478198-api-reference-layout
Open

Document layout.api-reference-layout#6596
devin-ai-integration[bot] wants to merge 1 commit into
mainfrom
devin/1786478198-api-reference-layout

Conversation

@devin-ai-integration

Copy link
Copy Markdown
Contributor

Summary

Documents the new site-level layout.api-reference-layout key, which selects how nested object fields render in the API Reference: indented (default, connector-line tree with a path breadcrumb per level) or cards (the previous bordered-card nesting).

layout:
  api-reference-layout: cards # opt back into nested cards

Two edits:

  • navigation/site-level-settings.mdx — canonical <ParamField> for the key, plus the key in the layout example 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:

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

Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
@devin-ai-integration

Copy link
Copy Markdown
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment, CI, and merge conflict monitoring

@github-actions

Copy link
Copy Markdown
Contributor

@devalog devalog added the blocked Blocked on engineering work/feature implementation, not ready to merge. label Aug 12, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

blocked Blocked on engineering work/feature implementation, not ready to merge.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants