Skip to content

Commit 53f9de5

Browse files
authored
Remove outdated info on pagination/long scrolling (#415)
1 parent 96e3b6c commit 53f9de5

File tree

1 file changed

+0
-15
lines changed

1 file changed

+0
-15
lines changed

fern/products/docs/pages/api-references/customize-api-ref.mdx

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,6 @@ You can hide an endpoint from the API reference by setting `hidden` to `true`. T
151151
```yaml title="docs.yml" {10}
152152
navigation:
153153
- api: API Reference
154-
paginated: true
155154
layout:
156155
- user:
157156
- endpoint: POST /user
@@ -165,7 +164,6 @@ You can hide an endpoint from the API reference by setting `hidden` to `true`. T
165164
```yaml title="docs.yml" {10}
166165
navigation:
167166
- api: API Reference
168-
paginated: true
169167
layout:
170168
- user:
171169
- endpoint: user.create
@@ -177,10 +175,6 @@ You can hide an endpoint from the API reference by setting `hidden` to `true`. T
177175
</Tab>
178176
</Tabs>
179177

180-
<Tip title="Fully hidden endpoints">
181-
For best results, API References with hidden endpoints should use the `paginated: true` configuration to avoid discovering endpoints from long-scrolling.
182-
</Tip>
183-
184178
### Adding custom sections
185179
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`.
186180

@@ -246,12 +240,3 @@ navigation:
246240
- link: Link Title
247241
href: http://google.com
248242
```
249-
250-
### Disable long-scrolling
251-
By default, the API Reference renders all endpoints on a single page (long-scrolling). To create separate pages for each endpoint, set `paginated: true`.
252-
253-
```yaml title="docs.yml"
254-
navigation:
255-
- api: API Reference
256-
paginated: true
257-
```

0 commit comments

Comments
 (0)