Skip to content

Remove outdated info on pagination/long scrolling #415

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 11, 2025
Merged

Remove outdated info on pagination/long scrolling #415

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 0 additions & 15 deletions fern/products/docs/pages/api-references/customize-api-ref.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,6 @@ You can hide an endpoint from the API reference by setting `hidden` to `true`. T
```yaml title="docs.yml" {10}
navigation:
- api: API Reference
paginated: true
layout:
- user:
- endpoint: POST /user
Expand All @@ -165,7 +164,6 @@ You can hide an endpoint from the API reference by setting `hidden` to `true`. T
```yaml title="docs.yml" {10}
navigation:
- api: API Reference
paginated: true
layout:
- user:
- endpoint: user.create
Expand All @@ -177,10 +175,6 @@ You can hide an endpoint from the API reference by setting `hidden` to `true`. T
</Tab>
</Tabs>

<Tip title="Fully hidden endpoints">
For best results, API References with hidden endpoints should use the `paginated: true` configuration to avoid discovering endpoints from long-scrolling.
</Tip>

### Adding custom sections
You can add arbitrary folders in the sidebar by adding a `section` to your API Reference layout. A section can comprise entire groups of endpoints, individual endpoints, or even just Markdown pages. Sections can be customized by adding properties like a `icon`, `summary`, `slug` (or `skip-slug`), and `contents`.

Expand Down Expand Up @@ -246,12 +240,3 @@ navigation:
- link: Link Title
href: http://google.com
```

### Disable long-scrolling
By default, the API Reference renders all endpoints on a single page (long-scrolling). To create separate pages for each endpoint, set `paginated: true`.

```yaml title="docs.yml"
navigation:
- api: API Reference
paginated: true
```