Skip to content

Commit 1cacaa7

Browse files
authored
Merge branch 'main' into kenny/add-ai-tooling-docs
2 parents 5fc0e0c + 3e5b927 commit 1cacaa7

File tree

38 files changed

+317
-229
lines changed

38 files changed

+317
-229
lines changed

fern/docs.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -303,10 +303,14 @@ redirects:
303303
destination: /learn/docs/writing-content/components/accordions
304304
- source: /learn/docs/writing-content/components/card-groups
305305
destination: /learn/docs/writing-content/components/cards
306+
- source: /learn/docs/writing-content/components/embed
307+
destination: /learn/docs/writing-content/components/download
306308
- source: /learn/docs/building-and-customizing-your-docs/navigation
307309
destination: /learn/docs/configuration/navigation
308310
- source: /learn/docs/navigation/overview
309311
destination: /learn/docs/configuration/navigation
312+
- source: /learn/docs/configuration/folder-based-navigation
313+
destination: /learn/docs/configuration/navigation
310314
- source: /learn/docs/building-and-customizing-your-docs/versioning
311315
destination: /learn/docs/configuration/versions
312316
- source: /learn/docs/navigation/versions
@@ -467,6 +471,8 @@ redirects:
467471
destination: /learn/ask-fern/configuration/custom-prompts
468472
- source: /learn/ask-fern/configuration/locations-and-datasources
469473
destination: /learn/ask-fern/configuration/setup
474+
- source: /learn/ask-fern/configuration/custom-prompts
475+
destination: /learn/ask-fern/configuration/setup
470476

471477
# General Ask Fern patterns
472478
- source: /learn/ai-search/getting-started/:slug*

fern/products/ask-fern/ask-fern.yml

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,8 @@ navigation:
1010
- section: Configuration
1111
contents:
1212
- page: Setup
13-
path: ./pages/configuration/locations-and-datasources.mdx
13+
path: ./pages/configuration/setup.mdx
1414
slug: setup
15-
- page: Custom prompts
16-
path: ./pages/configuration/custom-prompting.mdx
1715
- page: Guidance
1816
path: ./pages/features/guidance.mdx
1917
- page: Documents

fern/products/ask-fern/pages/configuration/custom-prompting.mdx

Lines changed: 0 additions & 32 deletions
This file was deleted.
File renamed without changes.

fern/products/ask-fern/pages/getting-started/what-is-ask-fern.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ ai-search:
6060
<Card
6161
title="Custom prompting"
6262
icon="regular book-open"
63-
href="/learn/ask-fern/configuration/custom-prompts"
63+
href="/learn/ask-fern/configuration/setup#ai-searchsystem-prompt"
6464
>
6565
Write custom prompts to improve accuracy and tailor responses for your users.
6666
</Card>

fern/products/cli-api-reference/cli-changelog/2025-11-05.mdx

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,26 @@
1+
## 0.108.0
2+
**`(feat):`** Add position-based sorting for folder navigation in docs.yml. Pages can now control their order using a `position` field in frontmatter. Pages with position values sort first (ascending), then pages without position sort alphabetically.
3+
4+
Example:
5+
```markdown
6+
---
7+
position: 1
8+
---
9+
# Getting Started
10+
```
11+
12+
13+
**`(fix):`** Fix hot-reload in `fern docs dev` to detect frontmatter position changes. Previously, changing position values required restarting the dev server. Now position changes, file additions, and file deletions trigger automatic navigation rebuilds.
14+
15+
16+
## 0.107.11
17+
**`(fix):`** Fix AsyncAPI v3 message parsing where channel messages were not being included in generated WebSocket clients. Messages defined in AsyncAPI v3 specs are now correctly resolved and included in the SDK.
18+
19+
20+
## 0.107.10
21+
**`(chore):`** Update migration logic to support new generator versions with ir v61.
22+
23+
124
## 0.107.9
225
**`(fix):`** Implement variant ranking in anyOf/oneOf example generation to prefer variants that use provided examples without coercion over variants that require coercion or generate fallback examples. When a schema has anyOf: [number, string] with examples: ["2500"], the string variant is now preferred since it can use the provided example as-is, rather than the number variant which would coerce it to a number.
326

fern/products/docs/docs.yml

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -67,9 +67,9 @@ navigation:
6767
path: ./pages/component-library/default-components/code-blocks.mdx
6868
icon: fa-duotone fa-code
6969
slug: code-blocks
70-
- page: Embed
71-
path: ./pages/component-library/default-components/embed.mdx
72-
icon: fa-duotone fa-window-restore
70+
- page: Download
71+
path: ./pages/component-library/default-components/download.mdx
72+
icon: fa-duotone fa-download
7373
- page: Endpoint request snippet
7474
path: ./pages/component-library/default-components/endpoint-request-snippet.mdx
7575
icon: fa-duotone fa-arrow-up
@@ -274,6 +274,8 @@ navigation:
274274
slug: analytics/mixpanel
275275
- page: Postman
276276
path: ./pages/integrations/postman.mdx
277+
- page: Mintlify
278+
path: ./pages/integrations/mintlify.mdx
277279
- page: LaunchDarkly feature flags
278280
path: ./pages/integrations/feature-flags.mdx
279281
hidden: true

fern/products/docs/pages/changelog/2025-11-05.mdx

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,24 @@ curl https://docs.example.com/platform/overview \
1414
Content is served as clean Markdown for token-efficient processing.
1515

1616
Learn more in the [MCP server documentation](/learn/docs/ai-features/mcp-server).
17+
18+
## Folder-based navigation
19+
20+
Auto-generate navigation from a folder of markdown files using the new `folder` configuration. Instead of manually listing each page in `docs.yml`, point to a folder. Fern discovers all `.md` and `.mdx` files and adds them to the navigation.
21+
22+
```yaml docs.yml {6-10}
23+
navigation:
24+
- section: Getting started
25+
contents:
26+
- page: Introduction
27+
path: ./pages/intro.mdx
28+
- folder: ./pages/guides
29+
title: Guides # Display name for folder section
30+
icon: fa-regular fa-book
31+
collapsed: true
32+
availability: beta # Optional badge to display in navigation
33+
```
34+
35+
Subfolders become nested sections. Supported options: `title`, `slug`, `icon`, `collapsed`, `hidden`, `skip-slug`, `availability`.
36+
37+
[Learn more about navigation configuration](/learn/docs/configuration/navigation).
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
title: "Download"
3+
description: "Download assets like PDFs directly from your documentation"
4+
---
5+
6+
The `<Download>` component lets users download assets like PDFs directly from your documentation.
7+
8+
<Info>
9+
For information on how to embed assets, check out the documentation on [Images](/learn/docs/writing-content/markdown#images), [PDFs](/learn/docs/writing-content/markdown#pdfs), and [Videos](/learn/docs/writing-content/markdown#videos).
10+
</Info>
11+
12+
## Usage
13+
14+
<div className="highlight-frame">
15+
<Download src="./all-about-ferns.pdf">
16+
<Button intent="primary">Download PDF</Button>
17+
</Download>
18+
</div>
19+
20+
```jsx Markdown
21+
<Download src="./all-about-ferns.pdf">
22+
<Button intent="primary">Download PDF</Button>
23+
</Download>
24+
```
25+
26+
## Properties
27+
28+
<ParamField path="src" type="string" required={true}>
29+
Path to your local asset (relative to current MDX file). The asset must be located within the `fern` folder.
30+
</ParamField>
31+
32+
<ParamField path="children" type="React.ReactNode" required={true}>
33+
The text or element to display as the click target for the download.
34+
</ParamField>
35+
36+
<ParamField path="filename" type="string">
37+
The filename to use for the downloaded asset. If not provided, the filename will be the same as the asset's name.
38+
</ParamField>

fern/products/docs/pages/component-library/default-components/embed.mdx

Lines changed: 0 additions & 115 deletions
This file was deleted.

0 commit comments

Comments
 (0)