Skip to content

Commit 25b72ab

Browse files
committed
small fixes
1 parent 430a819 commit 25b72ab

File tree

2 files changed

+13
-11
lines changed

2 files changed

+13
-11
lines changed

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

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -176,7 +176,7 @@ You can hide an endpoint from the API reference by setting `hidden` to `true`. T
176176
</Tabs>
177177

178178
### Adding custom sections
179-
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`.
179+
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`), `availability`, and `contents`.
180180

181181
<Tabs>
182182
<Tab title="OpenAPI Specification">
@@ -243,18 +243,20 @@ navigation:
243243

244244
### Adding availability
245245

246-
You can set the availability for the entire API reference or for specific sections.
246+
You can set the availability for the entire API reference or for specific sections. Options are: `stable`, `generally-available`, `in-development`, `pre-release`, `deprecated`, or `beta`.
247247

248-
```yaml title="docs.yml" {5}
248+
249+
```yaml title="docs.yml" {3, 6}
249250
navigation:
250251
- api: API Reference
252+
availability: generally-available
251253
layout:
252-
- user:
253-
availability: generally-available
254-
- POST /user
255-
- PUT /user/{username}
256-
- DELETE /user/{username}
257-
```
258-
When you set availability for an API Reference section, all child endpoints will inherit that availability unless explicitly overridden in your API definition.
254+
- section: My Section
255+
availability: beta
256+
icon: flower
257+
contents:
258+
```
259+
260+
When you set availability for a section, all endpoints in that section will inherit the section-level availability unless explicitly overridden in your API definition.
259261

260262
<Warning>You can't set availability for individual endpoints in `docs.yml`. Endpoint availability must be configured directly in your API definition. Learn more about availability for [OpenAPI](/learn/api-definitions/openapi/extensions/availability) or [Fern Definition](/learn/api-definitions/ferndef/availability).</Warning>

fern/products/docs/pages/navigation/versions.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ versions:
121121
```
122122
</CodeBlock>
123123

124-
Version availability is distinct from [section and page availability](/learn/docs/configuration/navigation#section-and-page-availability). If you want to set section and page availability, do so in your version-specific `yml` files.
124+
Version availability is distinct from [section and page availability](/learn/docs/configuration/navigation#section-and-page-availability), with different options. If you want to set section and page availability, do so in your version-specific `yml` files.
125125

126126
</Step>
127127
<Step title="Remove extra navigation from docs.yml">

0 commit comments

Comments
 (0)