Skip to content

Make config options visible instead of buried in Expandables - #398

Open
tillrohrmann wants to merge 1 commit into
config-oneof-variant-labelsfrom
config-reference-flatten
Open

Make config options visible instead of buried in Expandables#398
tillrohrmann wants to merge 1 commit into
config-oneof-variant-labelsfrom
config-reference-flatten

Conversation

@tillrohrmann

@tillrohrmann tillrohrmann commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

Reading this page meant clicking. Measured before this change:

hidden behind options
nothing 184 (44%)
an Expandable labelled "Properties" 112 (27%)
a oneOf variant 119 (29%)

worker was 13 visible against 91 hidden, and metadata-client and network-error-retry-policy were hidden entirely.

Sub-sections get their own headings. 85% of options are now on the page with no interaction, and the sidebar reaches worker.invoker rather than stopping at worker. Not done by expanding the boxes by default: Expandable has no defaultOpen, so that would mean forcing open from JS, which fights the component and permanently corrupts Mintlify's TOC scroll-spy.

Tagged enums say how to select them. The type field is now a normal option listing the values it accepts, and each value's extra options sit in a tab instead of a collapsed box. A variant whose only field is the discriminator gets no container at all.

Each key is rendered once. Shared options were repeated inside every variant, which had metadata-client.backoff-policy.type appearing nine times.

Expandables drop from 49 to 2, with no option added or lost — 336 distinct keys before and after.


Stack created with GitHub Stacks CLIGive Feedback 💬

@tillrohrmann
tillrohrmann force-pushed the config-reference-flatten branch 2 times, most recently from 7924a21 to eaeb9fc Compare September 1, 2026 21:02
Reading this page meant clicking: 56% of options sat behind an Expandable
labelled "Properties", and metadata-client and network-error-retry-policy
were hidden entirely. Sub-sections now get their own headings, so 85% of
options are on the page with no interaction and the sidebar reaches
worker.invoker rather than stopping at worker.

Tagged enums gave no clue you had to pick one. The `type` field is now a
normal option listing the values it accepts, and each value's extra options
sit in a tab instead of a collapsed box, which is what "pick exactly one"
looks like.

Each key is rendered once. Shared options were repeated inside every variant,
which had metadata-client.backoff-policy.type appearing nine times.

Expandables drop from 49 to 2, with no option added or lost.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@tillrohrmann
tillrohrmann force-pushed the config-reference-flatten branch from eaeb9fc to d0a5af7 Compare September 1, 2026 21:08
@tillrohrmann tillrohrmann changed the title Flatten the config reference so options are visible, not buried Make config options visible instead of buried in Expandables Sep 1, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant