From e1cf10693dc2f38c5048998dfb313cb7fc54812f Mon Sep 17 00:00:00 2001 From: Devin Logan Date: Wed, 23 Jul 2025 17:15:28 -0400 Subject: [PATCH 01/12] add quickstart cards --- fern/products/sdks/fern-folder.mdx | 23 +++++++++++++++++++++-- 1 file changed, 21 insertions(+), 2 deletions(-) diff --git a/fern/products/sdks/fern-folder.mdx b/fern/products/sdks/fern-folder.mdx index 78ed7ec40..edbe31ecb 100644 --- a/fern/products/sdks/fern-folder.mdx +++ b/fern/products/sdks/fern-folder.mdx @@ -1,6 +1,6 @@ --- -title: Set up the Fern Folder -description: Describes the Fern folder structure +title: Quickstart +description: Set up the fern folder --- Configuring Fern starts with the `fern` folder, the root directory that contains @@ -28,6 +28,25 @@ in different languages. {/* */} + + ### Generate an SDK in your desired language + + + + + + + + + + + + + + + + + From 57da78282a96c1de0ebd16c308300b1bb55e697f Mon Sep 17 00:00:00 2001 From: Devin Logan Date: Wed, 23 Jul 2025 17:25:26 -0400 Subject: [PATCH 02/12] cards with some icons --- fern/products/sdks/fern-folder.mdx | 26 +++++++++++++------------- fern/products/sdks/sdks.yml | 2 +- 2 files changed, 14 insertions(+), 14 deletions(-) diff --git a/fern/products/sdks/fern-folder.mdx b/fern/products/sdks/fern-folder.mdx index edbe31ecb..1a43059ae 100644 --- a/fern/products/sdks/fern-folder.mdx +++ b/fern/products/sdks/fern-folder.mdx @@ -1,5 +1,5 @@ --- -title: Quickstart +title: Set up the fern folder description: Set up the fern folder --- @@ -27,28 +27,28 @@ in different languages. - {/* */} - - ### Generate an SDK in your desired language + {/* */} + + + ### Generate an SDK in your desired language - + - + - + - + - + - + + + - - - ## Learn more about the initialized files diff --git a/fern/products/sdks/sdks.yml b/fern/products/sdks/sdks.yml index 857f5b139..356c3b77c 100644 --- a/fern/products/sdks/sdks.yml +++ b/fern/products/sdks/sdks.yml @@ -3,7 +3,7 @@ navigation: contents: - page: Introduction path: ./introduction.mdx - - page: Set up the Fern Folder + - page: Quickstart path: ./fern-folder.mdx - page: Capabilities path: ./capabilities.mdx From 3fd113b7c035108e7075112f489ce5a7376e6952 Mon Sep 17 00:00:00 2001 From: Devin Logan Date: Wed, 23 Jul 2025 17:41:20 -0400 Subject: [PATCH 03/12] first pass at quickstart cards --- fern/products/sdks/fern-folder.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/fern/products/sdks/fern-folder.mdx b/fern/products/sdks/fern-folder.mdx index 1a43059ae..feaab9c76 100644 --- a/fern/products/sdks/fern-folder.mdx +++ b/fern/products/sdks/fern-folder.mdx @@ -33,7 +33,7 @@ in different languages. ### Generate an SDK in your desired language - + From 736ec721055b86907a729a3199c6ba141075829c Mon Sep 17 00:00:00 2001 From: Kapil Gowru Date: Thu, 24 Jul 2025 00:30:09 -0400 Subject: [PATCH 04/12] feat: add logos to sdk cards --- fern/products/sdks/fern-folder.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/fern/products/sdks/fern-folder.mdx b/fern/products/sdks/fern-folder.mdx index 52baf3c1c..8d4270f1b 100644 --- a/fern/products/sdks/fern-folder.mdx +++ b/fern/products/sdks/fern-folder.mdx @@ -33,7 +33,7 @@ in different languages. ### Generate an SDK in your desired language - + } href="/sdks/generators/typescript/quickstart"> From ba1e6a26a602982cd0465fbf0cf83bf5cb979802 Mon Sep 17 00:00:00 2001 From: Kapil Gowru Date: Thu, 24 Jul 2025 00:37:37 -0400 Subject: [PATCH 05/12] feat: added logos for all languages --- fern/products/sdks/fern-folder.mdx | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/fern/products/sdks/fern-folder.mdx b/fern/products/sdks/fern-folder.mdx index 8d4270f1b..a7a6acd1c 100644 --- a/fern/products/sdks/fern-folder.mdx +++ b/fern/products/sdks/fern-folder.mdx @@ -33,19 +33,19 @@ in different languages. ### Generate an SDK in your desired language - } href="/sdks/generators/typescript/quickstart"> + } href="/sdks/generators/typescript/quickstart"> - + } href="/sdks/generators/python/quickstart"> - + } href="/sdks/generators/go/quickstart"> - + } href="/sdks/generators/java/quickstart"> - + } href="/sdks/generators/csharp/quickstart"> - + } href="/sdks/generators/php/quickstart"> - + } href="/sdks/generators/php/quickstart"> From 008f76f2a3716bf2a50d102ca1578c83c4aececd Mon Sep 17 00:00:00 2001 From: Kapil Gowru Date: Thu, 24 Jul 2025 01:01:45 -0400 Subject: [PATCH 06/12] feat: added logos for all languages --- fern/products/sdks/fern-folder.mdx | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/fern/products/sdks/fern-folder.mdx b/fern/products/sdks/fern-folder.mdx index a7a6acd1c..02be7ced0 100644 --- a/fern/products/sdks/fern-folder.mdx +++ b/fern/products/sdks/fern-folder.mdx @@ -33,19 +33,19 @@ in different languages. ### Generate an SDK in your desired language - } href="/sdks/generators/typescript/quickstart"> + } href="/sdks/generators/typescript/quickstart"> - } href="/sdks/generators/python/quickstart"> + } href="/sdks/generators/python/quickstart"> - } href="/sdks/generators/go/quickstart"> + } href="/sdks/generators/go/quickstart"> - } href="/sdks/generators/java/quickstart"> + } href="/sdks/generators/java/quickstart"> - } href="/sdks/generators/csharp/quickstart"> + } href="/sdks/generators/csharp/quickstart"> - } href="/sdks/generators/php/quickstart"> + } href="/sdks/generators/php/quickstart"> - } href="/sdks/generators/php/quickstart"> + } href="/sdks/generators/php/quickstart"> From 2da576241ea31c6800d16378f7e90b21d88a08d6 Mon Sep 17 00:00:00 2001 From: Kapil Gowru Date: Thu, 24 Jul 2025 15:30:35 -0400 Subject: [PATCH 07/12] feat: fixing mobile and adding og:images --- card-group-example.mdx | 17 ---- fern/assets/styles.css | 49 ++++++++-- fern/docs.yml | 9 +- .../docs/pages/getting-started/quickstart.mdx | 92 +++++-------------- fern/products/sdks/introduction.mdx | 6 +- 5 files changed, 72 insertions(+), 101 deletions(-) delete mode 100644 card-group-example.mdx diff --git a/card-group-example.mdx b/card-group-example.mdx deleted file mode 100644 index e3c9abff3..000000000 --- a/card-group-example.mdx +++ /dev/null @@ -1,17 +0,0 @@ - - - Start building beautiful documentation in under 5 minutes. - - - - One simple file that can be used to generate documentation that fits your brand. - - - - Use pre-built or custom React components for a polished look. - - - - Modify your documentation without touching code and publish to your GitHub. - - \ No newline at end of file diff --git a/fern/assets/styles.css b/fern/assets/styles.css index 990236544..cbbde768c 100644 --- a/fern/assets/styles.css +++ b/fern/assets/styles.css @@ -39,8 +39,16 @@ /*** START -- PRODUCT SELECTOR STYLING ***/ @media (min-width: 1024px) { + div[data-testid="product-dropdown-content"] { + border-radius: 1.5rem !important; + } + .fern-product-selector { - transform: translate(-2px, 4px); + transform: translate(-2px, 2px);; + } + + .product-item-title { + font-size: 1.25rem; } div:has(> .fern-product-selector-radio-group) { @@ -165,6 +173,20 @@ } } +@media (max-width: 640px) { + .fern-product-selector-radio-group { + width: 100%; + } + + div[data-testid="product-dropdown-content"] { + width: calc(100vw - 2rem) !important; + } + + div.fern-scroll-area-viewport.group\/sidebar.mask-grad-y-3.sticky.overscroll-contain > div > div { + border-top-width: 0px !important; + } +} + :is(.dark) .fern-product-selector-radio-group a[href*="home"] img { content: url("https://fern-docs.s3.us-east-2.amazonaws.com/product-switcher/product-switcher-home-dark.png") !important; } @@ -279,10 +301,6 @@ a[href*="changelog"] svg { .sdks-homepage { position: relative; - .fern-card { - text-decoration: none !important; - } - .dashed-pattern-left { position: absolute; left: -4rem; @@ -309,11 +327,16 @@ a[href*="changelog"] svg { -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%); } + .card-group { + grid-template-columns: repeat(2, minmax(0, 1fr)) !important; + } + .fern-card { border: none !important; padding: 0 !important; box-shadow: none !important; background-color: transparent !important; + text-decoration: none !important; .external-link-icon { display: none !important; @@ -415,6 +438,12 @@ a[href*="changelog"] svg { background-image: radial-gradient(farthest-side, var(--blue-3), transparent); } +@media (max-width: 640px) { + .bg-gradient-blue-left, .bg-gradient-green-right, .bg-gradient-blue-right, .bg-gradient-green-left { + display: none; + } +} + .lp-page-container { min-height: 100vh; position: relative; @@ -693,7 +722,7 @@ a[href*="changelog"] svg { /* Responsive Design - Mobile First */ @media (max-width: 640px) { .main-content { - padding: 2rem 1.5rem; + padding: 2rem 1rem; } .dashed-pattern-left { @@ -709,7 +738,7 @@ a[href*="changelog"] svg { } .hero-title-container { - padding: 0 1.5rem; + padding: 0 1rem; } .feature-grid { @@ -719,18 +748,18 @@ a[href*="changelog"] svg { } .sdks-card { - padding: 1.5rem; + padding: 1rem; } .docs-card { - padding: 1.5rem; + padding: 1rem; border-left: none; grid-column: 1; grid-row: auto; } .ai-search-card { - padding: 1.5rem; + padding: 1rem; } .card-title { diff --git a/fern/docs.yml b/fern/docs.yml index b98a38de0..d2cb8a868 100644 --- a/fern/docs.yml +++ b/fern/docs.yml @@ -8,7 +8,14 @@ instances: repo: docs branch: main -title: Fern +title: Fern Documentation + +metadata: + # Core platform identity + og:site_name: "Fern Documentation" + og:title: "Fern Documentation" + og:description: "Explore our guides for how to generate SDKs and Docs with Fern." + og:image: products: - display-name: Home diff --git a/fern/products/docs/pages/getting-started/quickstart.mdx b/fern/products/docs/pages/getting-started/quickstart.mdx index 6f648a8df..547e4042a 100644 --- a/fern/products/docs/pages/getting-started/quickstart.mdx +++ b/fern/products/docs/pages/getting-started/quickstart.mdx @@ -87,12 +87,12 @@ In this guide, we'll show you how to get started with Fern in under 5 minutes. -### Update your docs + ### Update your docs - - We provide a white-glove migration service as part of our Enterprise plan. Interested? Request it - [here](https://buildwithfern.com/contact). - + + We provide a white-glove migration service as part of our Enterprise plan. Interested? Request it + [here](https://buildwithfern.com/contact). + @@ -166,9 +166,24 @@ In this guide, we'll show you how to get started with Fern in under 5 minutes. -### Publish to production + ### Preview your docs + + + You can preview your docs locally for testing purposes by following the instructions [here](/docs/preview-publish/previewing-changes-locally). + + + `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). + + + + ### Publish to production + + When you are ready for your docs to be publicly accessible, you can publish them using the Fern CLI. + + [Read more.](/learn/docs/preview-publish/publishing-your-docs) + Fern supports hosting your docs website on a custom domain or on a 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. -Below are some examples of documentation websites that have been published using Fern: - - - } - /> - - } - /> - } - /> - } - /> - } - /> - - } - /> - - } - /> - - } - /> - \ No newline at end of file +[View examples of documentation websites](https://buildwithfern.com/customers) that have been published using Fern. \ No newline at end of file diff --git a/fern/products/sdks/introduction.mdx b/fern/products/sdks/introduction.mdx index 3d916bcab..614a8103e 100644 --- a/fern/products/sdks/introduction.mdx +++ b/fern/products/sdks/introduction.mdx @@ -13,7 +13,7 @@ description: Generate idiomatic SDKs in multiple programming languages
{/*
*/}
- + - - + + From c8ceb2520f0494c1e4ea232389971ea64eecc164 Mon Sep 17 00:00:00 2001 From: Kapil Gowru Date: Thu, 24 Jul 2025 15:54:17 -0400 Subject: [PATCH 08/12] feat: added ogimage --- fern/docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/fern/docs.yml b/fern/docs.yml index 8636c3940..b23611c3e 100644 --- a/fern/docs.yml +++ b/fern/docs.yml @@ -15,7 +15,7 @@ metadata: og:site_name: "Fern Documentation" og:title: "Fern Documentation" og:description: "Explore our guides for how to generate SDKs and Docs with Fern." - og:image: + og:image: https://fern-docs.s3.us-east-2.amazonaws.com/fern-docs-og_image-compressed.png products: - display-name: Home From 2686228a70a69f31bc2847e25e6686f125304316 Mon Sep 17 00:00:00 2001 From: Kapil Gowru Date: Thu, 24 Jul 2025 16:09:24 -0400 Subject: [PATCH 09/12] feat: updated og:description --- fern/docs.yml | 4 ---- fern/products/home/pages/welcome.mdx | 4 ++-- 2 files changed, 2 insertions(+), 6 deletions(-) diff --git a/fern/docs.yml b/fern/docs.yml index b23611c3e..fc3e85145 100644 --- a/fern/docs.yml +++ b/fern/docs.yml @@ -11,10 +11,6 @@ instances: title: Fern Documentation metadata: - # Core platform identity - og:site_name: "Fern Documentation" - og:title: "Fern Documentation" - og:description: "Explore our guides for how to generate SDKs and Docs with Fern." og:image: https://fern-docs.s3.us-east-2.amazonaws.com/fern-docs-og_image-compressed.png products: diff --git a/fern/products/home/pages/welcome.mdx b/fern/products/home/pages/welcome.mdx index 1d959a9bc..35cab6796 100644 --- a/fern/products/home/pages/welcome.mdx +++ b/fern/products/home/pages/welcome.mdx @@ -1,6 +1,6 @@ --- -title: The Fern Platform -description: Input OpenAPI. Output SDKs and Docs. +title: Build with Fern +description: Explore our guides for how to generate SDKs and Docs with Fern. slug: / hide-toc: true layout: custom From 8db6436b35bbe03d4e8b84f4ba1fc4c6d50ea628 Mon Sep 17 00:00:00 2001 From: Kapil Gowru Date: Thu, 24 Jul 2025 16:15:49 -0400 Subject: [PATCH 10/12] feat: updated og:description --- fern/docs.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/fern/docs.yml b/fern/docs.yml index fc3e85145..b950b417f 100644 --- a/fern/docs.yml +++ b/fern/docs.yml @@ -12,6 +12,7 @@ title: Fern Documentation metadata: og:image: https://fern-docs.s3.us-east-2.amazonaws.com/fern-docs-og_image-compressed.png + twitter:image: https://fern-docs.s3.us-east-2.amazonaws.com/fern-docs-og_image-compressed.png products: - display-name: Home From b46b406eea31744889c0cc2d84501e486d811a63 Mon Sep 17 00:00:00 2001 From: Kapil Gowru Date: Thu, 24 Jul 2025 17:09:08 -0400 Subject: [PATCH 11/12] feat: updated og:description --- fern/assets/styles.css | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/fern/assets/styles.css b/fern/assets/styles.css index cbbde768c..874490507 100644 --- a/fern/assets/styles.css +++ b/fern/assets/styles.css @@ -386,7 +386,7 @@ a[href*="changelog"] svg { } .bg-gradient-blue-left { - background-image: radial-gradient(farthest-side, var(--blue-2), transparent) !important; + background-image: radial-gradient(farthest-side, #1F2A3D, transparent) !important; } .bg-gradient-green-right { From 9c5570624f3cd261b99d5f4506ab73997d49d1e0 Mon Sep 17 00:00:00 2001 From: Kapil Gowru Date: Thu, 24 Jul 2025 17:13:02 -0400 Subject: [PATCH 12/12] feat: updated og:description --- fern/assets/styles.css | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/fern/assets/styles.css b/fern/assets/styles.css index 874490507..f278f36f2 100644 --- a/fern/assets/styles.css +++ b/fern/assets/styles.css @@ -386,7 +386,7 @@ a[href*="changelog"] svg { } .bg-gradient-blue-left { - background-image: radial-gradient(farthest-side, #1F2A3D, transparent) !important; + background-image: radial-gradient(farthest-side, var(--blue-2), transparent) !important; } .bg-gradient-green-right { @@ -412,7 +412,6 @@ a[href*="changelog"] svg { width: 800px; height: 600px; position: fixed; - filter: hue-rotate(30deg); transform: translate(-60%, 50%) rotate(-30deg); background-image: radial-gradient(farthest-side, var(--blue-3), transparent); } @@ -433,7 +432,6 @@ a[href*="changelog"] svg { height: 600px; position: fixed; right: 0; - filter: hue-rotate(30deg); transform: translate(60%, 50%) rotate(30deg); background-image: radial-gradient(farthest-side, var(--blue-3), transparent); }