Skip to content

Commit 1ee34e8

Browse files
kgowruKapil GowruKapil Gowru
authored
feat(docs): migrate sdk guides kg (#64)
Co-authored-by: Kapil Gowru <[email protected]> Co-authored-by: Kapil Gowru <[email protected]>
1 parent ca81178 commit 1ee34e8

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

57 files changed

+1286
-203
lines changed

fern/assets/styles.css

Lines changed: 6 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@
66
appearance: none;
77
}
88

9+
#builtwithfern {
10+
display: none !important;
11+
}
12+
913
.motivation p {
1014
max-width: unset !important;
1115
}
@@ -283,11 +287,10 @@
283287
left: -24px;
284288
top: 0;
285289
height: 100%;
286-
width: 1.5rem;
290+
width: 1rem;
287291
opacity: 1;
288292
pointer-events: none;
289293
border-right: 1px solid var(--grayscale-5);
290-
border-left: 1px solid var(--grayscale-5);
291294
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%);
292295
-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%);
293296
}
@@ -297,21 +300,10 @@
297300
right: -24px;
298301
top: 0;
299302
height: 100%;
300-
width: 1.5rem;
303+
width: 1rem;
301304
opacity: 1;
302305
pointer-events: none;
303306
border-right: 1px solid var(--grayscale-5);
304-
border-left: 1px solid var(--grayscale-5);
305-
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%);
306-
-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%);
307-
}
308-
309-
.dashed-gradient {
310-
height: 100%;
311-
width: 100%;
312-
background-image: url('data:image/svg+xml;utf8,<svg width="100" height="100" viewBox="0 0 100 100" fill="none" xmlns="http://www.w3.org/2000/svg"><g clip-path="url(%23clip0_351_76922)"><rect width="100" height="100" fill="transparent"/><path d="M0 100L100 -7.07537e-07" stroke="%23E0E1E6" stroke-width="4" stroke-linecap="round" stroke-linejoin="round"/></g><defs><clipPath id="clip0_351_76922"><rect width="100" height="100" fill="white"/></clipPath></defs></svg>');
313-
background-repeat: repeat;
314-
background-size: 12px 12px;
315307
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%);
316308
-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%);
317309
}

fern/footer-dist/output.js

Lines changed: 31 additions & 15 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

fern/products/api-definition/pages/openapi/extensions/others.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -384,7 +384,7 @@ paths:
384384
client.users.get("user-1234")
385385
```
386386

387-
If you're on the Fern Starter plan or higher for SDKs you won't have to worry about manually adding code samples! Our generators do that for you.
387+
If you're on the Fern Basic plan or higher for SDKs you won't have to worry about manually adding code samples! Our generators do that for you.
388388

389389
## Availability
390390

fern/products/docs/docs.yml

Lines changed: 30 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ navigation:
1212
- page: Setting up your domain
1313
path: ./pages/getting-started/setting-up-your-domain.mdx
1414
- link: Customer Showcase
15-
href: https://buildwithfern.com/docs/getting-started/customers
15+
href: https://buildwithfern.com/customers
1616
- section: Component Library
1717
contents:
1818
- section: Writing Content
@@ -25,46 +25,62 @@ navigation:
2525
contents:
2626
- page: Overview
2727
path: ./pages/component-library/default-components/overview.mdx
28+
icon: fa-regular fa-file
2829
- page: Accordions
2930
path: ./pages/component-library/default-components/accordions.mdx
31+
icon: fa-regular fa-chevron-down
3032
- page: Accordion Groups
3133
path: ./pages/component-library/default-components/accordion-groups.mdx
34+
icon: fa-regular fa-chevrons-down
3235
- page: Aside
3336
path: ./pages/component-library/default-components/aside.mdx
37+
icon: fa-regular fa-comment-dots
3438
- page: Callouts
3539
path: ./pages/component-library/default-components/callouts.mdx
40+
icon: fa-regular fa-exclamation-triangle
3641
- page: Cards
3742
path: ./pages/component-library/default-components/cards.mdx
43+
icon: fa-regular fa-id-card
3844
- page: Card Groups
3945
path: ./pages/component-library/default-components/card-groups.mdx
46+
icon: fa-regular fa-grid-2
4047
- page: Code Blocks
4148
path: ./pages/component-library/default-components/code-blocks.mdx
49+
icon: fa-regular fa-code
4250
- page: Embed
4351
path: ./pages/component-library/default-components/embed.mdx
52+
icon: fa-regular fa-window-restore
4453
- page: Endpoint Request Snippet
4554
path: ./pages/component-library/default-components/endpoint-request-snippet.mdx
55+
icon: fa-regular fa-arrow-up
4656
- page: Endpoint Response Snippet
4757
path: ./pages/component-library/default-components/endpoint-response-snippet.mdx
58+
icon: fa-regular fa-arrow-down
4859
- page: Endpoint Schema Snippet
4960
path: ./pages/component-library/default-components/endpoint-schema-snippet.mdx
61+
icon: fa-regular fa-sitemap
5062
- page: Frames
5163
path: ./pages/component-library/default-components/frames.mdx
64+
icon: fa-regular fa-window-maximize
5265
- page: Icons
5366
path: ./pages/component-library/default-components/icons.mdx
67+
icon: fa-regular fa-icons
5468
- page: Parameter Fields
5569
path: ./pages/component-library/default-components/parameter-fields.mdx
70+
icon: fa-regular fa-list
5671
- page: Steps
5772
path: ./pages/component-library/default-components/steps.mdx
73+
icon: fa-regular fa-list-ol
5874
- page: Tabs
5975
path: ./pages/component-library/default-components/tabs.mdx
76+
icon: fa-regular fa-folder-open
6077
- page: Tooltips
6178
path: ./pages/component-library/default-components/tooltips.mdx
62-
- section: Custom Components
63-
contents:
64-
- page: Reusable Snippets
65-
path: ./pages/component-library/custom-components/reusable-snippets.mdx
66-
- page: Custom React Components
67-
path: ./pages/component-library/custom-components/custom-react-components.mdx
79+
icon: fa-regular fa-comment
80+
- page: Reusable Snippets
81+
path: ./pages/component-library/custom-components/reusable-snippets.mdx
82+
- page: Custom React Components
83+
path: ./pages/component-library/custom-components/custom-react-components.mdx
6884
- section: Configuration
6985
collapsed: true
7086
contents:
@@ -79,8 +95,6 @@ navigation:
7995
contents:
8096
- page: Overview
8197
path: ./pages/navigation/overview.mdx
82-
- page: Tabs
83-
path: ./pages/navigation/tabs.mdx
8498
- page: Versions
8599
path: ./pages/navigation/versions.mdx
86100
- page: Products
@@ -136,10 +150,17 @@ navigation:
136150
- section: Authentication
137151
collapsed: true
138152
contents:
153+
- page: SSO
154+
path: ./pages/authentication/sso.mdx
139155
- page: RBAC
140156
path: ./pages/authentication/rbac.mdx
141157
- page: API Key Injection
142158
path: ./pages/api-references/autopopulate-api-key.mdx
159+
- section: Enterprise
160+
collapsed: true
161+
contents:
162+
- page: Self-hosted
163+
path: ./pages/enterprise/self-hosted.mdx
143164
- section: Integrations
144165
collapsed: true
145166
contents:

fern/products/docs/pages/api-references/sdk-snippets.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ groups:
5353

5454
<Callout intent='info'>
5555
SDK snippets automatically populated in your Fern Docs is a paid feature included
56-
in the [SDK Starter plan](https://buildwithfern.com/pricing).
56+
in the [SDK Basic plan](https://buildwithfern.com/pricing).
5757
</Callout>
5858

5959
### Add the package name to your docs configuration

fern/products/docs/pages/authentication/sso.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@
22
title: Single Sign-On
33
---
44

5-
How to configure Single Sign-On (SSO) for your documentation platform.
5+
Fern supports SSO so that your docs site is gated for your team and customers.
66

7-
<Warning>This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/docs/getting-started/overview).</Warning>
7+
<Warning>Docs are coming soon for this page.<br/><br/>Please [book a demo](https://buildwithfern.com/book-demo) or [reach out to us](https://buildwithfern.com/book-demo) to get set up with this feature. </Warning>

fern/products/docs/pages/enterprise/self-hosted.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@
22
title: Self-hosted Enterprise
33
---
44

5-
Information about self-hosted enterprise solutions for your documentation platform.
5+
Fern supports self-hosting so that you can run your docs site on your own infrastructure.
66

7-
<Warning>This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/docs/getting-started/overview).</Warning>
7+
<Warning>Docs are coming soon for this page.<br/><br/>Please [book a demo](https://buildwithfern.com/book-demo) or [reach out to us](https://buildwithfern.com/book-demo) to get set up with this feature. </Warning>

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

Lines changed: 134 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -8,59 +8,148 @@ description: Meet documentation that is stunning by default, AI-ready, and desig
88
.fern-card {
99
text-decoration: none !important;
1010
}
11+
12+
.docs-homepage {
13+
position: relative;
14+
15+
.dashed-pattern-left {
16+
position: absolute;
17+
left: -4rem;
18+
top: -8.5rem;
19+
height: calc(100% + 26rem);
20+
width: 1rem;
21+
opacity: 1;
22+
pointer-events: none;
23+
border-right: 1px solid var(--grayscale-5);
24+
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%);
25+
-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%);
26+
}
27+
28+
.dashed-pattern-right {
29+
position: absolute;
30+
right: -4rem;
31+
top: -8.5rem;
32+
height: calc(100% + 26rem);
33+
width: 1rem;
34+
opacity: 1;
35+
pointer-events: none;
36+
border-left: 1px solid var(--grayscale-5);
37+
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%);
38+
-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%);
39+
}
40+
41+
42+
.fern-card {
43+
border: none !important;
44+
padding: 0 !important;
45+
box-shadow: none !important;
46+
background-color: transparent !important;
47+
48+
.card-title {
49+
display: flex;
50+
gap: 0.25rem;
51+
align-items: center;
52+
}
53+
54+
img {
55+
transition: transform 0.15s ease-in-out;
56+
}
57+
58+
.arrow-right {
59+
height: 1rem;
60+
opacity: 0;
61+
transition: opacity 0.15s ease-in-out, transform 0.15s ease-in-out;
62+
transform: translateX(0px);
63+
}
64+
65+
&:hover {
66+
img {
67+
transform: scale(1.01);
68+
}
69+
70+
.arrow-right {
71+
opacity: 1;
72+
transform: translateX(2px);
73+
}
74+
}
75+
}
76+
}
1177
`}
1278
</style>
1379

14-
<CardGroup cols={2}>
15-
<a class="fern-card interactive not-prose rounded-3 relative block border p-6 text-base" href="/docs/guides/getting-started/quickstart">
16-
<div class="flex items-start flex-col space-y-3">
17-
<img class="mx-auto dark:hidden" alt="Quickstart" src="./images/quickstart.png" />
18-
<img class="mx-auto hidden dark:block" alt="Quickstart" src="./images/quickstart-dark.png" />
19-
<div class="w-full space-y-1 overflow-hidden">
20-
<div class="text-(color:--grayscale-a12) text-body text-base font-semibold">Quickstart</div>
21-
<div class="text-(color:--grayscale-a11) font-light">
22-
<p>Start building beautiful documentation in under 5 minutes.</p>
80+
<div className="docs-homepage">
81+
{/* Dashed Pattern - Left Side */}
82+
<div className="dashed-pattern-left"></div>
83+
84+
{/* Dashed Pattern - Right Side */}
85+
<div className="dashed-pattern-right"></div>
86+
<CardGroup cols={2}>
87+
<a class="fern-card interactive not-prose relative block p-6 text-base" href="/docs/guides/getting-started/quickstart">
88+
<div class="flex items-start flex-col space-y-3">
89+
<img class="mx-auto dark:hidden" alt="Quickstart" src="./images/quickstart.png" />
90+
<img class="mx-auto hidden dark:block" alt="Quickstart" src="./images/quickstart-dark.png" />
91+
<div class="w-full space-y-1 overflow-hidden">
92+
<div class="text-(color:--grayscale-a12) text-body text-base font-semibold card-title">
93+
Quickstart
94+
<img src="./images/arrow-right-black.svg" alt="Arrow right light" className="arrow-right dark:hidden m-0" noZoom />
95+
<img src="./images/arrow-right-white.svg" alt="Arrow right light" className="arrow-right hidden dark:block m-0" noZoom />
96+
</div>
97+
<div class="text-(color:--grayscale-a11) font-light">
98+
<p>Start building beautiful documentation in under 5 minutes.</p>
99+
</div>
23100
</div>
24101
</div>
25-
</div>
26-
</a>
27-
28-
<a class="fern-card interactive not-prose rounded-3 relative block border p-6 text-base" href="/docs/guides/getting-started/what-is-docs-yml">
29-
<div class="flex items-start flex-col space-y-3">
30-
<img class="mx-auto dark:hidden" alt="Configure with ease" src="./images/configure.png" />
31-
<img class="mx-auto hidden dark:block" alt="Configure with ease" src="./images/configure-dark.png" />
32-
<div class="w-full space-y-1 overflow-hidden">
33-
<div class="text-(color:--grayscale-a12) text-body text-base font-semibold">Configure with ease</div>
34-
<div class="text-(color:--grayscale-a11) font-light">
35-
<p>One simple file that can be used to generate documentation that fits your brand.</p>
102+
</a>
103+
104+
<a class="fern-card interactive not-prose rounded-3 relative block border p-6 text-base" href="/docs/guides/getting-started/what-is-docs-yml">
105+
<div class="flex items-start flex-col space-y-3">
106+
<img class="mx-auto dark:hidden" alt="Configure with ease" src="./images/configure.png" />
107+
<img class="mx-auto hidden dark:block" alt="Configure with ease" src="./images/configure-dark.png" />
108+
<div class="w-full space-y-1 overflow-hidden">
109+
<div class="text-(color:--grayscale-a12) text-body text-base font-semibold card-title">
110+
Configure with ease
111+
<img src="./images/arrow-right-black.svg" alt="Arrow right light" className="arrow-right dark:hidden m-0" noZoom />
112+
<img src="./images/arrow-right-white.svg" alt="Arrow right light" className="arrow-right hidden dark:block m-0" noZoom />
113+
</div>
114+
<div class="text-(color:--grayscale-a11) font-light">
115+
<p>One simple file that can be used to generate documentation that fits your brand.</p>
116+
</div>
36117
</div>
37118
</div>
38-
</div>
39-
</a>
40-
41-
<a class="fern-card interactive not-prose rounded-3 relative block border p-6 text-base" href="/docs/component-library/overview">
42-
<div class="flex items-start flex-col space-y-3">
43-
<img class="mx-auto dark:hidden" alt="Flexible component library" src="./images/component-library.png" />
44-
<img class="mx-auto hidden dark:block" alt="Flexible component library" src="./images/component-library-dark.png" />
45-
<div class="w-full space-y-1 overflow-hidden">
46-
<div class="text-(color:--grayscale-a12) text-body text-base font-semibold">Flexible component library</div>
47-
<div class="text-(color:--grayscale-a11) font-light">
48-
<p>Use pre-built or custom React components for a polished look.</p>
119+
</a>
120+
121+
<a class="fern-card interactive not-prose rounded-3 relative block border p-6 text-base" href="/docs/component-library/overview">
122+
<div class="flex items-start flex-col space-y-3">
123+
<img class="mx-auto dark:hidden" alt="Flexible component library" src="./images/component-library.png" />
124+
<img class="mx-auto hidden dark:block" alt="Flexible component library" src="./images/component-library-dark.png" />
125+
<div class="w-full space-y-1 overflow-hidden">
126+
<div class="text-(color:--grayscale-a12) text-body text-base font-semibold card-title">
127+
Flexible component library
128+
<img src="./images/arrow-right-black.svg" alt="Arrow right light" className="arrow-right dark:hidden m-0" noZoom />
129+
<img src="./images/arrow-right-white.svg" alt="Arrow right light" className="arrow-right hidden dark:block m-0" noZoom />
130+
</div>
131+
<div class="text-(color:--grayscale-a11) font-light">
132+
<p>Use pre-built or custom React components for a polished look.</p>
133+
</div>
49134
</div>
50135
</div>
51-
</div>
52-
</a>
53-
54-
<a class="fern-card interactive not-prose rounded-3 relative block border p-6 text-base" href="/docs/component-library/writing-content/visual-editor">
55-
<div class="flex items-start flex-col space-y-3">
56-
<img class="mx-auto dark:hidden" alt="Visual Editor" src="./images/visual-editor.png" />
57-
<img class="mx-auto hidden dark:block" alt="Visual Editor" src="./images/visual-editor-dark.png" />
58-
<div class="w-full space-y-1 overflow-hidden">
59-
<div class="text-(color:--grayscale-a12) text-body text-base font-semibold">Visual Editor</div>
60-
<div class="text-(color:--grayscale-a11) font-light">
61-
<p>Modify your documentation without touching code and publish to your GitHub.</p>
136+
</a>
137+
138+
<a class="fern-card interactive not-prose rounded-3 relative block border p-6 text-base" href="/docs/component-library/writing-content/visual-editor">
139+
<div class="flex items-start flex-col space-y-3">
140+
<img class="mx-auto dark:hidden" alt="Visual Editor" src="./images/visual-editor.png" />
141+
<img class="mx-auto hidden dark:block" alt="Visual Editor" src="./images/visual-editor-dark.png" />
142+
<div class="w-full space-y-1 overflow-hidden">
143+
<div class="text-(color:--grayscale-a12) text-body text-base font-semibold card-title">
144+
Visual Editor
145+
<img src="./images/arrow-right-black.svg" alt="Arrow right light" className="arrow-right dark:hidden m-0" noZoom />
146+
<img src="./images/arrow-right-white.svg" alt="Arrow right light" className="arrow-right hidden dark:block m-0" noZoom />
147+
</div>
148+
<div class="text-(color:--grayscale-a11) font-light">
149+
<p>Modify your documentation without touching code and publish to your GitHub.</p>
150+
</div>
62151
</div>
63152
</div>
64-
</div>
65-
</a>
66-
</CardGroup>
153+
</a>
154+
</CardGroup>
155+
</div>

0 commit comments

Comments
 (0)