docs: clarify API Reference paginated navigation option#6101
Open
fern-api[bot] wants to merge 1 commit into
Open
docs: clarify API Reference paginated navigation option#6101fern-api[bot] wants to merge 1 commit into
paginated navigation option#6101fern-api[bot] wants to merge 1 commit into
Conversation
Contributor
|
🌿 Preview your docs: https://fern-preview-devin-1783426694-clarify-paginated-api-reference.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
Clarifies the
paginatedoption on the API Reference navigation item indocs.yml, which is easy to misread as an "infinite scroll" toggle when it does the opposite.paginated: false) renders the whole API Reference as a single long-scrolling page.paginated: truesplits the API Reference into one page per endpoint.paginatedentry to the Configuration options referenceParamFieldlist.Verified the key name, placement, default, and in-development status against the
docs.ymlschema (ApiReferenceConfiguration) infern-api/fern.Surfaced by a customer who set
paginatedexpecting long-scrolling and got per-endpoint pages instead.