Skip to content

Commit a72497b

Browse files
author
ml-241
authored
Merge branch 'fern-api:main' into main
2 parents ab47b41 + 5d653d8 commit a72497b

40 files changed

+214
-164
lines changed

.github/workflows/publish-docs.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,5 +19,4 @@ jobs:
1919
env:
2020
FERN_TOKEN: ${{ secrets.FERN_TOKEN }}
2121
run: |
22-
fern generate --docs --instance fern-api.docs.buildwithfern.com/learn
23-
fern generate --docs --instance fern-v2.docs.buildwithfern.com/learn/v2
22+
fern generate --docs --instance fern.docs.buildwithfern.com/learn

card-group-example.mdx

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

fern/assets/styles.css

Lines changed: 39 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,16 @@
3939

4040
/*** START -- PRODUCT SELECTOR STYLING ***/
4141
@media (min-width: 1024px) {
42+
div[data-testid="product-dropdown-content"] {
43+
border-radius: 1.5rem !important;
44+
}
45+
4246
.fern-product-selector {
43-
transform: translate(-2px, 4px);
47+
transform: translate(-2px, 2px);;
48+
}
49+
50+
.product-item-title {
51+
font-size: 1.25rem;
4452
}
4553

4654
div:has(> .fern-product-selector-radio-group) {
@@ -165,6 +173,20 @@
165173
}
166174
}
167175

176+
@media (max-width: 640px) {
177+
.fern-product-selector-radio-group {
178+
width: 100%;
179+
}
180+
181+
div[data-testid="product-dropdown-content"] {
182+
width: calc(100vw - 2rem) !important;
183+
}
184+
185+
div.fern-scroll-area-viewport.group\/sidebar.mask-grad-y-3.sticky.overscroll-contain > div > div {
186+
border-top-width: 0px !important;
187+
}
188+
}
189+
168190
:is(.dark) .fern-product-selector-radio-group a[href*="home"] img {
169191
content: url("https://fern-docs.s3.us-east-2.amazonaws.com/product-switcher/product-switcher-home-dark.png") !important;
170192
}
@@ -279,10 +301,6 @@ a[href*="changelog"] svg {
279301
.sdks-homepage {
280302
position: relative;
281303

282-
.fern-card {
283-
text-decoration: none !important;
284-
}
285-
286304
.dashed-pattern-left {
287305
position: absolute;
288306
left: -4rem;
@@ -309,11 +327,16 @@ a[href*="changelog"] svg {
309327
-webkit-mask: linear-gradient(to bottom, transparent 0%, rgba(0,0,0,1) 10%, rgba(0,0,0,1) 90%, rgba(0,0,0,0) 100%);
310328
}
311329

330+
.card-group {
331+
grid-template-columns: repeat(2, minmax(0, 1fr)) !important;
332+
}
333+
312334
.fern-card {
313335
border: none !important;
314336
padding: 0 !important;
315337
box-shadow: none !important;
316338
background-color: transparent !important;
339+
text-decoration: none !important;
317340

318341
.external-link-icon {
319342
display: none !important;
@@ -389,7 +412,6 @@ a[href*="changelog"] svg {
389412
width: 800px;
390413
height: 600px;
391414
position: fixed;
392-
filter: hue-rotate(30deg);
393415
transform: translate(-60%, 50%) rotate(-30deg);
394416
background-image: radial-gradient(farthest-side, var(--blue-3), transparent);
395417
}
@@ -410,11 +432,16 @@ a[href*="changelog"] svg {
410432
height: 600px;
411433
position: fixed;
412434
right: 0;
413-
filter: hue-rotate(30deg);
414435
transform: translate(60%, 50%) rotate(30deg);
415436
background-image: radial-gradient(farthest-side, var(--blue-3), transparent);
416437
}
417438

439+
@media (max-width: 640px) {
440+
.bg-gradient-blue-left, .bg-gradient-green-right, .bg-gradient-blue-right, .bg-gradient-green-left {
441+
display: none;
442+
}
443+
}
444+
418445
.lp-page-container {
419446
min-height: 100vh;
420447
position: relative;
@@ -693,7 +720,7 @@ a[href*="changelog"] svg {
693720
/* Responsive Design - Mobile First */
694721
@media (max-width: 640px) {
695722
.main-content {
696-
padding: 2rem 1.5rem;
723+
padding: 2rem 1rem;
697724
}
698725

699726
.dashed-pattern-left {
@@ -709,7 +736,7 @@ a[href*="changelog"] svg {
709736
}
710737

711738
.hero-title-container {
712-
padding: 0 1.5rem;
739+
padding: 0 1rem;
713740
}
714741

715742
.feature-grid {
@@ -719,18 +746,18 @@ a[href*="changelog"] svg {
719746
}
720747

721748
.sdks-card {
722-
padding: 1.5rem;
749+
padding: 1rem;
723750
}
724751

725752
.docs-card {
726-
padding: 1.5rem;
753+
padding: 1rem;
727754
border-left: none;
728755
grid-column: 1;
729756
grid-row: auto;
730757
}
731758

732759
.ai-search-card {
733-
padding: 1.5rem;
760+
padding: 1rem;
734761
}
735762

736763
.card-title {

fern/docs.yml

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,18 @@
11
instances:
22
- url: fern-v2.docs.buildwithfern.com/learn/v2
3-
- url: fern-api.docs.buildwithfern.com/learn
4-
custom-domain: buildfern.com/learn
3+
- url: fern.docs.buildwithfern.com/learn
4+
custom-domain: buildwithfern.com/learn
55
edit-this-page:
66
github:
77
owner: fern-api
88
repo: docs
99
branch: main
1010

11-
title: Fern
11+
title: Fern Documentation
12+
13+
metadata:
14+
og:image: https://fern-docs.s3.us-east-2.amazonaws.com/fern-docs-og_image-compressed.png
15+
twitter:image: https://fern-docs.s3.us-east-2.amazonaws.com/fern-docs-og_image-compressed.png
1216

1317
products:
1418
- display-name: Home
@@ -537,4 +541,4 @@ redirects:
537541
permanent: true
538542
- source: /learn/api-reference/tokens/:slug*
539543
destination: /learn/cli-api-reference/api-reference/tokens/:slug*
540-
permanent: true
544+
permanent: true
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
## 0.65.30
2+
**`(feat):`** Support example generation for multiple examples.
3+
4+

fern/products/docs/pages/component-library/custom-components/reusable-markdown.mdx

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,15 +34,17 @@ To use a snippet in your documentation, reference it by its file path (including
3434

3535
<Tabs>
3636
<Tab title="Markdown">
37-
```mdx
37+
38+
```jsx
3839
Peace lilies are easy to grow and relatively trouble-free.
3940

40-
<Markdown src="/snippets/peace-lily.mdx" />
41+
<Markdown src="/snippets/peace-lily.mdx">
4142
```
43+
4244
</Tab>
4345
<Tab title="Preview">
4446
Peace lilies are easy to grow and relatively trouble-free.
45-
47+
4648
<Markdown src="/snippets/peace-lily.mdx" />
4749
</Tab>
4850
</Tabs>

fern/products/docs/pages/getting-started/quickstart.mdx

Lines changed: 22 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -87,12 +87,12 @@ In this guide, we'll show you how to get started with Fern in under 5 minutes.
8787

8888
</AccordionGroup>
8989

90-
### Update your docs
90+
### Update your docs
9191

92-
<Note>
93-
We provide a white-glove migration service as part of our Enterprise plan. Interested? Request it
94-
[here](https://buildwithfern.com/contact).
95-
</Note>
92+
<Note>
93+
We provide a white-glove migration service as part of our Enterprise plan. Interested? Request it
94+
[here](https://buildwithfern.com/contact).
95+
</Note>
9696

9797
<AccordionGroup toc={true}>
9898
<Accordion title='Add content' >
@@ -166,9 +166,24 @@ In this guide, we'll show you how to get started with Fern in under 5 minutes.
166166

167167
</AccordionGroup>
168168

169-
### Publish to production
169+
### Preview your docs
170+
<AccordionGroup toc={true}>
171+
<Accordion title='Preview your docs locally'>
172+
You can preview your docs locally for testing purposes by following the instructions [here](/docs/preview-publish/previewing-changes-locally).
173+
</Accordion>
174+
<Accordion title='Preview your docs in a PR'>
175+
`PR previews` offer a way to preview changes from pull requests (PRs) before merging code to a production branch. Learn more [here](/docs/preview-publish/previewing-changes-in-a-pr).
176+
</Accordion>
177+
</AccordionGroup>
178+
179+
### Publish to production
170180

171181
<AccordionGroup toc={true}>
182+
<Accordion title='Publishing your docs'>
183+
When you are ready for your docs to be publicly accessible, you can publish them using the Fern CLI.
184+
185+
[Read more.](/learn/docs/preview-publish/publishing-your-docs)
186+
</Accordion>
172187
<Accordion title='Host on a custom domain'>
173188
Fern supports hosting your docs website on a custom domain or on a
174189
custom subpath (e.g. https://domain.com/docs).
@@ -185,67 +200,4 @@ In this guide, we'll show you how to get started with Fern in under 5 minutes.
185200

186201
</Steps>
187202

188-
Below are some examples of documentation websites that have been published using Fern:
189-
190-
<CardGroup cols={3}>
191-
<Card
192-
title="Hume"
193-
href="https://dev.hume.ai/intro"
194-
icon={<img src="https://www.hume.ai/icons/icon-144x144.png" alt="Hume logo" />}
195-
/>
196-
<Card
197-
title="Primer"
198-
href="https://primer.io/docs/api"
199-
icon={
200-
<img
201-
src="https://assets-global.website-files.com/65bcc4714739c54deeb9bac7/65d7663e0ceca67e8b5709c5_favicon.png"
202-
alt="Primer logo"
203-
/>
204-
}
205-
/>
206-
<Card
207-
title="AssemblyAI"
208-
href="https://www.assemblyai.com/docs/api-reference"
209-
icon={<img src="https://www.assemblyai.com/favicon.png" alt="AssemblyAI logo" />}
210-
/>
211-
<Card
212-
title="SuperAgent"
213-
href="https://docs.superagent.sh/"
214-
icon={<img src="https://framerusercontent.com/images/P75NaYul3IVsoMqx4RMALvngO4.png" alt="SuperAgent logo" />}
215-
/>
216-
<Card
217-
title="MultiOn"
218-
href="https://docs.multion.ai/"
219-
icon={<img src="https://cdn.prod.website-files.com/67be56277f6d514dcad939e2/67e48a0c27c90b3f0b51d7ad_logo-agi.png" alt="MultiOn logo" />}
220-
/>
221-
<Card
222-
title="Coactive"
223-
href="https://docs.coactive.ai/"
224-
icon={
225-
<img
226-
src="https://images.prismic.io/coactive/6d31b17f-cabb-492d-93ef-a9f42e03aaa2_coactive-logo-home.png?ixlib=gatsbyFP&auto=compress%2Cformat&fit=max"
227-
alt="Coactive logo"
228-
/>
229-
}
230-
/>
231-
<Card
232-
title="Zep"
233-
href="https://help.getzep.com/"
234-
icon={
235-
<img
236-
src="https://assets-global.website-files.com/660b1c076d13b7e2967a499d/660c6dc329d8b16a8468f5ba_Asset%2017.png"
237-
alt="Zep logo"
238-
/>
239-
}
240-
/>
241-
<Card
242-
title="Rightbrain"
243-
href="https://docs.rightbrain.ai/intro"
244-
icon={
245-
<img
246-
src="https://fdr-prod-docs-files-public.s3.amazonaws.com/https://rightbrain.docs.buildwithfern.com/2024-08-05T10:16:06.892Z/docs/assets/Logo.png"
247-
alt="Rightbrain logo"
248-
/>
249-
}
250-
/>
251-
</CardGroup>
203+
[View examples of documentation websites](https://buildwithfern.com/customers) that have been published using Fern.

fern/products/home/pages/welcome.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: The Fern Platform
3-
description: Input OpenAPI. Output SDKs and Docs.
2+
title: Build with Fern
3+
description: Explore our guides for how to generate SDKs and Docs with Fern.
44
slug: /
55
hide-toc: true
66
layout: custom

fern/products/sdks/guides/setup-local-sdk-previews.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ groups:
3636
python-sdk:
3737
generators:
3838
- name: fernapi/fern-python-sdk
39-
version: <Markdown src="/snippets/version-number.mdx"/>
39+
version: <Markdown src="/snippets/version-number-python.mdx"/>
4040
output:
4141
location: pypi
4242
package-name: imdb

fern/products/sdks/introduction.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ description: Generate idiomatic SDKs in multiple programming languages
1313
<div className="dashed-pattern-right">
1414
{/* <div className="dashed-gradient"></div> */}
1515
</div>
16-
<CardGroup cols={2}>
16+
<div className="card-group my-6 grid gap-4 first:mt-0 sm:gap-6">
1717
<a class="fern-card interactive not-prose relative block p-6 text-base" href="/sdks/generators/typescript/quickstart">
1818
<div class="flex items-start flex-col space-y-3">
1919
<img class="mx-auto dark:hidden" alt="TypeScript" src="./images/typescript-card.png" />
@@ -171,5 +171,5 @@ description: Generate idiomatic SDKs in multiple programming languages
171171
</div>
172172
</div>
173173
</a>
174-
</CardGroup>
175-
</div>
174+
</div>
175+
</div>

0 commit comments

Comments
 (0)