Skip to content

docs: clarify API Reference paginated navigation option#6101

Merged
devalog merged 2 commits into
mainfrom
devin/1783426694-clarify-paginated-api-reference
Jul 13, 2026
Merged

docs: clarify API Reference paginated navigation option#6101
devalog merged 2 commits into
mainfrom
devin/1783426694-clarify-paginated-api-reference

Conversation

@fern-api

@fern-api fern-api Bot commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

Summary

Clarifies the paginated option on the API Reference navigation item in docs.yml, which is easy to misread as an "infinite scroll" toggle when it does the opposite.

  • Adds a Paginating endpoints subsection to the API Reference layout page explaining that:
    • The default (omit the property, or paginated: false) renders the whole API Reference as a single long-scrolling page.
    • paginated: true splits the API Reference into one page per endpoint.
    • The option controls page layout only and is unrelated to endpoint (cursor/offset) pagination.
    • The option is in development.
  • Adds a paginated entry to the Configuration options reference ParamField list.

Verified the key name, placement, default, and in-development status against the docs.yml schema (ApiReferenceConfiguration) in fern-api/fern.

Surfaced by a customer who set paginated expecting long-scrolling and got per-endpoint pages instead.

@fern-api
fern-api Bot requested a review from devalog as a code owner July 7, 2026 12:19
@github-actions

github-actions Bot commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

@devalog
devalog merged commit baba7f2 into main Jul 13, 2026
4 checks passed
@devalog
devalog deleted the devin/1783426694-clarify-paginated-api-reference branch July 13, 2026 16:43
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