diff --git a/fern/assets/changelogs/.DS_Store b/fern/assets/changelogs/.DS_Store index 64a701997..67f4afe2f 100644 Binary files a/fern/assets/changelogs/.DS_Store and b/fern/assets/changelogs/.DS_Store differ diff --git a/fern/assets/styles.css b/fern/assets/styles.css index 9b9d5b4d5..bc4bdca43 100644 --- a/fern/assets/styles.css +++ b/fern/assets/styles.css @@ -33,133 +33,209 @@ background-color: transparent !important; } -/* Custom styline for code blocks to match Fern site */ -/* .code-block-root { - box-shadow: 0 0 0 .0625rem #0e3f7e0a,0 .0625rem .0625rem -.003125rem #2a33450a,.1875rem .1875rem .1875rem -.09375rem #2a33460a,0 .375rem .375rem -.1875rem #2a33460a,0 .75rem .75rem -.375rem #0e3f7e0a,0 1.5rem 1.5rem -.75rem #0e3f7e0a,.5rem .5rem 3.5625rem 0 #e7e8ec; - border-radius: 0 0 .5rem .5rem; -} +/*** START -- PRODUCT SELECTOR STYLING ***/ -.bg-tag-default-soft { - box-shadow: 0 0 0 .0625rem #0e3f7e0a,0 .0625rem .0625rem -.003125rem #2a33450a,.1875rem .1875rem .1875rem -.09375rem #2a33460a,0 .375rem .375rem -.1875rem #2a33460a,0 .75rem .75rem -.375rem #0e3f7e0a,0 1.5rem 1.5rem -.75rem #0e3f7e0a,.5rem .5rem 3.5625rem 0 #e7e8ec; -} */ +@media (min-width: 1024px) { + .fern-product-selector { + transform: translate(-2px, 4px); + } -.fern-product-selector { - transform: translate(-2px, 4px); -} + div:has(> .fern-product-selector-radio-group) { + margin-top: 0.5rem; + } -div:has(> .fern-product-selector-radio-group) { - margin-top: 0.5rem; -} + div:has(> .fern-product-selector-radio-group):before { + content: "Explore the Fern Platform"; + font-weight: 500; + margin: 0.5rem 1rem 0 1rem; + } -div:has(> .fern-product-selector-radio-group):before { - content: "Explore the Fern Platform"; - font-weight: 500; - margin: 0.5rem 1rem 0 1rem; -} + .fern-product-selector-radio-group { + display: grid; + grid-template-columns: repeat(3, 1fr); + gap: 1.5rem; + padding: 1.25rem; + max-height: 232px; + + > a { + max-width: 320px; + margin: -0.75rem; + position: relative; -.fern-product-selector-radio-group { - display: grid; - grid-template-columns: repeat(3, 1fr); - gap: 1.5rem; - padding: 1.25rem; - max-height: 232px; - - > a { - max-width: 320px; - margin: -0.75rem; - position: relative; + .fern-selection-item{ + border-radius: 1rem; + } + } - .fern-selection-item{ - border-radius: 1rem; + > a[href*="home"] { + grid-column: 1; + grid-row: 1; } - } - > a[href="/home"] { - grid-column: 1; - grid-row: 1; - } + > a[href*="sdks"] { + grid-column: 2; + grid-row: 1; + } - > a[href="/sdks"] { - grid-column: 2; - grid-row: 1; - } + > a[href*="docs"] { + grid-column: 1; + grid-row: 2; + } - > a[href="/docs"] { - grid-column: 1; - grid-row: 2; - } + > a[href*="ask-fern"] { + grid-column: 2; + grid-row: 2; + } - > a[href="/ask-fern"] { - grid-column: 2; - grid-row: 2; - } + > a[href*="openapi"]:before { + content: "Supported Specs"; + font-weight: 500; + position: absolute; + top: -2rem; + left: 0.5rem; + } - > a[href="/openapi"]:before { - content: "Supported Specs"; - font-weight: 500; - position: absolute; - top: -2rem; - left: 0.5rem; - } + > a[href*="openapi"] { + grid-column: 3; + grid-row: 1; - > a[href="/openapi"] { - grid-column: 3; - grid-row: 1; + .fern-selection-item-icon { + width: 1.5rem; + height: 1.5rem; + } + } - .fern-selection-item-icon { - width: 1.5rem; - height: 1.5rem; + > a[href*="fern-def"] { + grid-column: 3; + grid-row: 2; + transform: translateY(-32px); + + .fern-selection-item-icon { + width: 1.5rem; + height: 1.5rem; + } } - } - > a[href="/fern-def"] { - grid-column: 3; - grid-row: 2; - transform: translateY(-32px); - - .fern-selection-item-icon { - width: 1.5rem; - height: 1.5rem; + > a[href*="asyncapi"] { + grid-column: 3; + grid-row: 3; + transform: translateY(-64px); + + .fern-selection-item-icon { + width: 1.5rem; + height: 1.5rem; + } } - } - > a[href="/asyncapi"] { - grid-column: 3; - grid-row: 3; - transform: translateY(-64px); + > a[href*="openrpc"] { + grid-column: 3; + grid-row: 4; + transform: translateY(-64px); - .fern-selection-item-icon { - width: 1.5rem; - height: 1.5rem; + .fern-selection-item-icon { + width: 1.5rem; + height: 1.5rem; + } } - } - > a[href="/openrpc"] { - grid-column: 3; - grid-row: 4; - transform: translateY(-64px); + > a[href*="grpc"] { + grid-column: 3; + grid-row: 5; + transform: translateY(-64px); - .fern-selection-item-icon { - width: 1.5rem; - height: 1.5rem; + .fern-selection-item-icon { + width: 1.5rem; + height: 1.5rem; + } } } +} + +: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; +} + +:is(.dark) .fern-product-selector-radio-group a[href*="sdks"] img { + content: url("https://fern-docs.s3.us-east-2.amazonaws.com/product-switcher/product-switcher-sdks-dark.png") !important; +} - > a[href="/grpc"] { - grid-column: 3; - grid-row: 5; - transform: translateY(-64px); +:is(.dark) .fern-product-selector-radio-group a[href*="docs"] img { + content: url("https://fern-docs.s3.us-east-2.amazonaws.com/product-switcher/product-switcher-docs-dark.png") !important; +} + +:is(.dark) .fern-product-selector-radio-group a[href*="ask-fern"] img { + content: url("https://fern-docs.s3.us-east-2.amazonaws.com/product-switcher/product-switcher-askfern-dark.png") !important; +} - .fern-selection-item-icon { - width: 1.5rem; - height: 1.5rem; +/*** END -- PRODUCT SELECTOR STYLING ***/ + + +/*** START -- LANDING PAGE STYLING ***/ +:is(.dark) { + .lp-page-container { + .dashed-gradient { + background-image: url('data:image/svg+xml;utf8,'); } } -} + .bg-gradient-green-left { + background-image: radial-gradient(farthest-side, var(--green-2), transparent) !important; + } + + .bg-gradient-blue-left { + background-image: radial-gradient(farthest-side, var(--blue-2), transparent) !important; + } + + .bg-gradient-green-right { + background-image: radial-gradient(farthest-side, var(--green-2), transparent) !important; + } + + .bg-gradient-blue-right { + background-image: radial-gradient(farthest-side, var(--blue-2), transparent) !important; + } +} + +.bg-gradient-green-left { + top: 0; + width: 700px; + height: 1000px; + position: fixed; + transform: translate(-50%, -10%) rotate(30deg); + background-image: radial-gradient(farthest-side, var(--green-3), transparent); +} + +.bg-gradient-blue-left { + top: 0; + 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); +} + +.bg-gradient-green-right { + top: 0; + width: 700px; + height: 1000px; + position: fixed; + right: 0; + transform: translate(50%, -10%) rotate(-30deg); + background-image: radial-gradient(farthest-side, var(--green-3), transparent); +} + +.bg-gradient-blue-right { + top: 0; + width: 800px; + 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); +} -/* LANDING */ .lp-page-container { min-height: 100vh; position: relative; @@ -174,6 +250,8 @@ div:has(> .fern-product-selector-radio-group):before { pointer-events: none; border-right: 1px solid var(--grayscale-5); border-left: 1px solid var(--grayscale-5); + 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%); + -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%); } .dashed-pattern-right { @@ -186,6 +264,8 @@ div:has(> .fern-product-selector-radio-group):before { pointer-events: none; border-right: 1px solid var(--grayscale-5); border-left: 1px solid var(--grayscale-5); + 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%); + -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%); } .dashed-gradient { @@ -194,10 +274,8 @@ div:has(> .fern-product-selector-radio-group):before { background-image: url('data:image/svg+xml;utf8,'); background-repeat: repeat; background-size: 12px 12px; - } - - &:is(.dark) .dashed-gradient { - background-image: url('data:image/svg+xml;utf8,'); + 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%); + -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%); } .main-content { @@ -442,6 +520,7 @@ div:has(> .fern-product-selector-radio-group):before { top: 50%; left: 0; transform: translate(-32px, calc(-50% - 4px)); + filter: saturate(0) opacity(0.7); } .footer-status { @@ -450,38 +529,6 @@ div:has(> .fern-product-selector-radio-group):before { gap: 1rem; } - .status-badge { - display: flex; - align-items: center; - gap: 0.5rem; - border-radius: 9999px; - padding: 0.25rem 0.75rem; - align-self: flex-start; - cursor: pointer; - text-decoration: none; - transition: background-color 150ms ease, color 150ms ease; - - svg { - display: none !important; - } - - &:hover { - background-color: var(--grayscale-a4); - - .status-text { - color: var(--grayscale-12); - } - } - } - - .status-indicator { - width: 0.375rem; - height: 0.375rem; - background-color: var(--green-a10); - border-radius: 50%; - box-shadow: 0 0 0 4px var(--green-a4); - } - .status-text { font-size: 0.875rem; color: var(--grayscale-10); @@ -579,17 +626,29 @@ div:has(> .fern-product-selector-radio-group):before { font-weight: 400 !important; width: fit-content !important; + img { + transition: transform 0.15s ease-in-out; + transform: translate(0px, 0px); + } + svg { display: none !important; } &.no-hover { cursor: default; + &:hover { background: none !important; color: var(--grayscale-a11) !important; } } + + &:hover { + img:not(:first-child) { + transform: translate(2px, 0px); + } + } } /* Responsive Design - Mobile First */ @@ -801,3 +860,4 @@ div:has(> .fern-product-selector-radio-group):before { } } +/*** END -- LANDING PAGE STYLING ***/ diff --git a/fern/components/FernStatus.tsx b/fern/components/FernStatus.tsx new file mode 100644 index 000000000..30f4b7702 --- /dev/null +++ b/fern/components/FernStatus.tsx @@ -0,0 +1,211 @@ +import React, { useState, useEffect } from 'react'; + +interface StatusData { + ongoing_incidents?: Array<{ + current_worst_impact: string; + }>; + in_progress_maintenances?: Array; + scheduled_maintenances?: Array<{ + starts_at: string; + }>; +} + +interface StatusState { + dotClass: string; + statusMessage: string; +} + +export const FernStatusWidget = () => { + const [status, setStatus] = React.useState({ + dotClass: 'is-loading', + statusMessage: 'Checking status...' + }); + + const apiEndpoint = 'https://status.buildwithfern.com/api/v1/summary'; + const refreshInterval = 5 * 60 * 1000; // 5 minutes + + const updateStatus = (data: StatusData) => { + let dotClass = 'is-green'; + let statusMessage = 'All systems operational'; + + // Check for ongoing incidents + if (data.ongoing_incidents && data.ongoing_incidents.length > 0) { + let worstImpact = 0; + for (const incident of data.ongoing_incidents) { + let impactLevel = 0; + + if (incident.current_worst_impact === 'degraded_performance') { + impactLevel = 1; + } else if (incident.current_worst_impact === 'partial_outage') { + impactLevel = 2; + } else if (incident.current_worst_impact === 'full_outage') { + impactLevel = 3; + } + + if (impactLevel > worstImpact) { + worstImpact = impactLevel; + } + } + + // Set status based on severity + if (worstImpact === 3) { + dotClass = 'is-red'; + statusMessage = 'Service outage'; + } else if (worstImpact === 2) { + dotClass = 'is-orange'; + statusMessage = 'Partial outage'; + } else if (worstImpact === 1) { + dotClass = 'is-yellow'; + statusMessage = 'Degraded performance'; + } + } + + // Check for in-progress maintenance + if (data.in_progress_maintenances && data.in_progress_maintenances.length > 0) { + if (dotClass === 'is-green') { + dotClass = 'is-blue'; + statusMessage = 'Maintenance in progress'; + } + } + + // Check for scheduled maintenance + if (data.scheduled_maintenances && data.scheduled_maintenances.length > 0) { + if (dotClass === 'is-green') { + const now = new Date(); + let soonMaintenance = false; + + for (const maintenance of data.scheduled_maintenances) { + const startsAt = new Date(maintenance.starts_at); + const hoursDiff = (startsAt.getTime() - now.getTime()) / (1000 * 60 * 60); + + if (hoursDiff <= 24) { + soonMaintenance = true; + break; + } + } + + if (soonMaintenance) { + dotClass = 'is-blue'; + statusMessage = 'Scheduled maintenance soon'; + } + } + } + + setStatus({ dotClass, statusMessage }); + }; + + const fetchStatus = async () => { + try { + const response = await fetch(apiEndpoint); + if (response.ok) { + const data: StatusData = await response.json(); + updateStatus(data); + } else { + setStatus({ dotClass: 'is-red', statusMessage: 'Cannot check status' }); + } + } catch (error) { + console.error('Error fetching status:', error); + setStatus({ dotClass: 'is-red', statusMessage: 'Cannot check status' }); + } + }; + + React.useEffect(() => { + fetchStatus(); + const interval = setInterval(fetchStatus, refreshInterval); + return () => clearInterval(interval); + }, []); + + const getBackgroundColor = () => { + switch (status.dotClass) { + case 'is-green': return '#00c853'; + case 'is-red': return '#f44336'; + case 'is-orange': return '#ff9800'; + case 'is-blue': return '#2196f3'; + case 'is-yellow': return '#ffc107'; + case 'is-loading': return '#cccccc'; + default: return '#cccccc'; + } + }; + + return ( + +
+
+ {status.statusMessage} + + +
+ + ); +}; diff --git a/fern/docs.yml b/fern/docs.yml index 21f75bfe8..981b90144 100644 --- a/fern/docs.yml +++ b/fern/docs.yml @@ -7,28 +7,28 @@ products: - display-name: Home path: ./products/home/home.yml # icon: fa-regular fa-home - image: ./images/product-switcher/home.svg + image: ./images/product-switcher/product-switcher-home-light.png slug: home - subtitle: Products that delight your developers + subtitle: Products that elevate your developer experience - display-name: SDKs path: ./products/sdks/sdks.yml icon: fa-brands fa-codepen - image: ./images/product-switcher/sdks.png + image: ./images/product-switcher/product-switcher-sdks-light.png slug: sdks subtitle: Generate client libraries in multiple languages - display-name: Docs path: ./products/docs/docs.yml icon: fa-regular fa-browser - image: ./images/product-switcher/docs.png + image: ./images/product-switcher/product-switcher-docs-light.png slug: docs subtitle: Generate beautiful, interactive documentation websites - display-name: Ask Fern path: ./products/ask-fern/ask-fern.yml icon: fa-regular fa-magnifying-glass - image: ./images/product-switcher/ask-fern.png + image: ./images/product-switcher/product-switcher-askfern-light.png slug: ask-fern subtitle: Let users find answers in your documentation instantly @@ -119,3 +119,7 @@ layout: header-height: 75px searchbar-placement: header tabs-placement: header + +experimental: + mdx-components: + - ./components \ No newline at end of file diff --git a/fern/images/.DS_Store b/fern/images/.DS_Store index 85960f7ac..d582c789a 100644 Binary files a/fern/images/.DS_Store and b/fern/images/.DS_Store differ diff --git a/fern/images/product-switcher/product-switcher-ai-search-dark.png b/fern/images/product-switcher/product-switcher-ai-search-dark.png new file mode 100644 index 000000000..9092dcea1 Binary files /dev/null and b/fern/images/product-switcher/product-switcher-ai-search-dark.png differ diff --git a/fern/images/product-switcher/product-switcher-askfern-dark.png b/fern/images/product-switcher/product-switcher-askfern-dark.png new file mode 100644 index 000000000..9092dcea1 Binary files /dev/null and b/fern/images/product-switcher/product-switcher-askfern-dark.png differ diff --git a/fern/images/product-switcher/product-switcher-askfern-light.png b/fern/images/product-switcher/product-switcher-askfern-light.png new file mode 100644 index 000000000..3332c1351 Binary files /dev/null and b/fern/images/product-switcher/product-switcher-askfern-light.png differ diff --git a/fern/images/product-switcher/product-switcher-docs-dark.png b/fern/images/product-switcher/product-switcher-docs-dark.png new file mode 100644 index 000000000..e4a50962c Binary files /dev/null and b/fern/images/product-switcher/product-switcher-docs-dark.png differ diff --git a/fern/images/product-switcher/product-switcher-docs-light.png b/fern/images/product-switcher/product-switcher-docs-light.png new file mode 100644 index 000000000..772cef6ca Binary files /dev/null and b/fern/images/product-switcher/product-switcher-docs-light.png differ diff --git a/fern/images/product-switcher/product-switcher-home-dark.png b/fern/images/product-switcher/product-switcher-home-dark.png new file mode 100644 index 000000000..162431442 Binary files /dev/null and b/fern/images/product-switcher/product-switcher-home-dark.png differ diff --git a/fern/images/product-switcher/product-switcher-home-light.png b/fern/images/product-switcher/product-switcher-home-light.png new file mode 100644 index 000000000..57c04cabc Binary files /dev/null and b/fern/images/product-switcher/product-switcher-home-light.png differ diff --git a/fern/images/product-switcher/product-switcher-sdks-dark.png b/fern/images/product-switcher/product-switcher-sdks-dark.png new file mode 100644 index 000000000..d591bf736 Binary files /dev/null and b/fern/images/product-switcher/product-switcher-sdks-dark.png differ diff --git a/fern/images/product-switcher/product-switcher-sdks-light.png b/fern/images/product-switcher/product-switcher-sdks-light.png new file mode 100644 index 000000000..d3253e8ac Binary files /dev/null and b/fern/images/product-switcher/product-switcher-sdks-light.png differ diff --git a/fern/products/asyncapi-def/pages/getting-started/customer-showcase.mdx b/fern/products/asyncapi-def/pages/getting-started/customer-showcase.mdx index b8913aadc..be7c06684 100644 --- a/fern/products/asyncapi-def/pages/getting-started/customer-showcase.mdx +++ b/fern/products/asyncapi-def/pages/getting-started/customer-showcase.mdx @@ -2,6 +2,6 @@ title: Customer Showcase --- -# Customer Showcase +Examples and case studies of customers using AsyncAPI definitions successfully. -See how other customers are using OpenAPI definitions to power their APIs and documentation. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn). \ No newline at end of file diff --git a/fern/products/asyncapi-def/pages/getting-started/get-to-openapi.mdx b/fern/products/asyncapi-def/pages/getting-started/get-to-openapi.mdx index 65cd466c8..faf5d5d7a 100644 --- a/fern/products/asyncapi-def/pages/getting-started/get-to-openapi.mdx +++ b/fern/products/asyncapi-def/pages/getting-started/get-to-openapi.mdx @@ -2,6 +2,6 @@ title: Get to OpenAPI --- -# Get to OpenAPI +How to transition from AsyncAPI to OpenAPI or integrate both specifications. -Learn how to create or obtain your OpenAPI definition. Explore different approaches including handwriting, generating from code, and more. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn). \ No newline at end of file diff --git a/fern/products/asyncapi-def/pages/getting-started/get-to-openapi/generate-it/fastapi.mdx b/fern/products/asyncapi-def/pages/getting-started/get-to-openapi/generate-it/fastapi.mdx index c8095e8a7..6ba0217d6 100644 --- a/fern/products/asyncapi-def/pages/getting-started/get-to-openapi/generate-it/fastapi.mdx +++ b/fern/products/asyncapi-def/pages/getting-started/get-to-openapi/generate-it/fastapi.mdx @@ -4,4 +4,6 @@ title: FastAPI # Generate OpenAPI from FastAPI -Instructions for generating an OpenAPI definition from a FastAPI project. \ No newline at end of file +Instructions for generating an OpenAPI definition from a FastAPI project. + +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn). diff --git a/fern/products/asyncapi-def/pages/getting-started/get-to-openapi/generate-it/nestjs.mdx b/fern/products/asyncapi-def/pages/getting-started/get-to-openapi/generate-it/nestjs.mdx index dfefb49b9..838467f79 100644 --- a/fern/products/asyncapi-def/pages/getting-started/get-to-openapi/generate-it/nestjs.mdx +++ b/fern/products/asyncapi-def/pages/getting-started/get-to-openapi/generate-it/nestjs.mdx @@ -4,4 +4,6 @@ title: NestJS # Generate OpenAPI from NestJS -Instructions for generating an OpenAPI definition from a NestJS project. \ No newline at end of file +Instructions for generating an OpenAPI definition from a NestJS project. + +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn). diff --git a/fern/products/asyncapi-def/pages/getting-started/get-to-openapi/generate-it/request-new-framework.mdx b/fern/products/asyncapi-def/pages/getting-started/get-to-openapi/generate-it/request-new-framework.mdx index 2daa88917..0ba737a50 100644 --- a/fern/products/asyncapi-def/pages/getting-started/get-to-openapi/generate-it/request-new-framework.mdx +++ b/fern/products/asyncapi-def/pages/getting-started/get-to-openapi/generate-it/request-new-framework.mdx @@ -1,7 +1,9 @@ --- -title: Request a new framework +title: Request New Framework --- # Request a New Framework -Don't see your framework? Let us know which framework you'd like to see supported for OpenAPI generation. \ No newline at end of file +Don't see your framework? Let us know which framework you'd like to see supported for OpenAPI generation. + +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn). \ No newline at end of file diff --git a/fern/products/asyncapi-def/pages/getting-started/get-to-openapi/generate-it/swaggo.mdx b/fern/products/asyncapi-def/pages/getting-started/get-to-openapi/generate-it/swaggo.mdx index 5512b276a..da566a29e 100644 --- a/fern/products/asyncapi-def/pages/getting-started/get-to-openapi/generate-it/swaggo.mdx +++ b/fern/products/asyncapi-def/pages/getting-started/get-to-openapi/generate-it/swaggo.mdx @@ -4,4 +4,6 @@ title: Swaggo # Generate OpenAPI from Swaggo -Instructions for generating an OpenAPI definition from a Swaggo (Go) project. \ No newline at end of file +Instructions for generating an OpenAPI definition from a Swaggo (Go) project. + +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn). diff --git a/fern/products/asyncapi-def/pages/getting-started/get-to-openapi/handwrite-it.mdx b/fern/products/asyncapi-def/pages/getting-started/get-to-openapi/handwrite-it.mdx index 6db37bb5b..28571f07c 100644 --- a/fern/products/asyncapi-def/pages/getting-started/get-to-openapi/handwrite-it.mdx +++ b/fern/products/asyncapi-def/pages/getting-started/get-to-openapi/handwrite-it.mdx @@ -1,7 +1,9 @@ --- -title: Handwrite it +title: Handwrite It --- # Handwrite Your OpenAPI Definition -Step-by-step guide to manually writing your OpenAPI definition from scratch. \ No newline at end of file +Step-by-step guide to manually writing your OpenAPI definition from scratch. + +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn). \ No newline at end of file diff --git a/fern/products/asyncapi-def/pages/getting-started/overlay-customizations.mdx b/fern/products/asyncapi-def/pages/getting-started/overlay-customizations.mdx index 26b75af7e..00fd99ab9 100644 --- a/fern/products/asyncapi-def/pages/getting-started/overlay-customizations.mdx +++ b/fern/products/asyncapi-def/pages/getting-started/overlay-customizations.mdx @@ -1,7 +1,7 @@ --- -title: Overlay customizations +title: Overlay Customizations --- -# Overlay Customizations +Learn how to customize your OpenAPI overlays to fit your unique requirements. -Learn how to customize your OpenAPI overlays to fit your unique requirements. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn). diff --git a/fern/products/asyncapi-def/pages/getting-started/overview.mdx b/fern/products/asyncapi-def/pages/getting-started/overview.mdx index 001442f88..d3b20d894 100644 --- a/fern/products/asyncapi-def/pages/getting-started/overview.mdx +++ b/fern/products/asyncapi-def/pages/getting-started/overview.mdx @@ -2,6 +2,6 @@ title: Overview --- -# Overview +This is the overview page for Getting Started with your OpenAPI definition. Here you will find a high-level introduction and guidance on how to begin. -This is the overview page for Getting Started with your OpenAPI definition. Here you will find a high-level introduction and guidance on how to begin. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn). \ No newline at end of file diff --git a/fern/products/asyncapi-def/pages/getting-started/philosophy.mdx b/fern/products/asyncapi-def/pages/getting-started/philosophy.mdx index 56f5a3b9a..7b9f1f487 100644 --- a/fern/products/asyncapi-def/pages/getting-started/philosophy.mdx +++ b/fern/products/asyncapi-def/pages/getting-started/philosophy.mdx @@ -2,6 +2,6 @@ title: Philosophy --- -# Philosophy +The philosophy and principles behind AsyncAPI definitions and how they enhance API development. -Understand the philosophy behind designing and maintaining your OpenAPI definitions. Learn best practices and guiding principles. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn). \ No newline at end of file diff --git a/fern/products/asyncapi-def/pages/schemas/allof.mdx b/fern/products/asyncapi-def/pages/schemas/allof.mdx index b2df5b757..16d657582 100644 --- a/fern/products/asyncapi-def/pages/schemas/allof.mdx +++ b/fern/products/asyncapi-def/pages/schemas/allof.mdx @@ -1,7 +1,7 @@ --- -title: AllOf +title: All Of --- -# AllOf +How to use the `allOf` keyword to compose schemas in OpenAPI. -How to use the `allOf` keyword to compose schemas in OpenAPI. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn). \ No newline at end of file diff --git a/fern/products/asyncapi-def/pages/schemas/anyof.mdx b/fern/products/asyncapi-def/pages/schemas/anyof.mdx index 04690e099..91fcdeab8 100644 --- a/fern/products/asyncapi-def/pages/schemas/anyof.mdx +++ b/fern/products/asyncapi-def/pages/schemas/anyof.mdx @@ -1,7 +1,7 @@ --- -title: AnyOf +title: Any Of --- -# AnyOf +How to use the `anyOf` keyword to allow multiple possible schemas in OpenAPI. -How to use the `anyOf` keyword to allow multiple possible schemas in OpenAPI. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn). \ No newline at end of file diff --git a/fern/products/asyncapi-def/pages/schemas/enums.mdx b/fern/products/asyncapi-def/pages/schemas/enums.mdx index c50286ca0..c9c85709a 100644 --- a/fern/products/asyncapi-def/pages/schemas/enums.mdx +++ b/fern/products/asyncapi-def/pages/schemas/enums.mdx @@ -2,6 +2,6 @@ title: Enums --- -# Enums +How to use enum types to define a fixed set of values in OpenAPI. -How to define and use enums in your OpenAPI schemas. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn). \ No newline at end of file diff --git a/fern/products/asyncapi-def/pages/schemas/inlined-schemas.mdx b/fern/products/asyncapi-def/pages/schemas/inlined-schemas.mdx index 68f31c620..9906fcf9d 100644 --- a/fern/products/asyncapi-def/pages/schemas/inlined-schemas.mdx +++ b/fern/products/asyncapi-def/pages/schemas/inlined-schemas.mdx @@ -2,6 +2,6 @@ title: Inlined Schemas --- -# Inlined Schemas +How to define schemas inline within your OpenAPI specification. -How to define inlined schemas directly within your OpenAPI definitions. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn). \ No newline at end of file diff --git a/fern/products/asyncapi-def/pages/schemas/objects.mdx b/fern/products/asyncapi-def/pages/schemas/objects.mdx index 3f4225bf2..393909d69 100644 --- a/fern/products/asyncapi-def/pages/schemas/objects.mdx +++ b/fern/products/asyncapi-def/pages/schemas/objects.mdx @@ -2,6 +2,6 @@ title: Objects --- -# Objects +How to define object schemas with properties in OpenAPI. -Learn how to define object schemas in OpenAPI, including properties and required fields. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn). \ No newline at end of file diff --git a/fern/products/asyncapi-def/pages/schemas/oneof.mdx b/fern/products/asyncapi-def/pages/schemas/oneof.mdx index 95e26147d..134e74233 100644 --- a/fern/products/asyncapi-def/pages/schemas/oneof.mdx +++ b/fern/products/asyncapi-def/pages/schemas/oneof.mdx @@ -1,7 +1,7 @@ --- -title: OneOf +title: One Of --- -# OneOf +How to use the `oneOf` keyword to define alternative schemas in OpenAPI. -How to use the `oneOf` keyword to define alternative schemas in OpenAPI. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn). \ No newline at end of file diff --git a/fern/products/asyncapi-def/pages/schemas/override-type.mdx b/fern/products/asyncapi-def/pages/schemas/override-type.mdx index acf4791c2..109113ac7 100644 --- a/fern/products/asyncapi-def/pages/schemas/override-type.mdx +++ b/fern/products/asyncapi-def/pages/schemas/override-type.mdx @@ -1,7 +1,7 @@ --- -title: Override the Type +title: Override Type --- -# Override the Type +How to override the default type inference for schemas in OpenAPI. -How to override the type of a schema in OpenAPI. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn). \ No newline at end of file diff --git a/fern/products/asyncapi-def/pages/security-schemes/multiple-security-schemes.mdx b/fern/products/asyncapi-def/pages/security-schemes/multiple-security-schemes.mdx index 286d0a352..57df008d3 100644 --- a/fern/products/asyncapi-def/pages/security-schemes/multiple-security-schemes.mdx +++ b/fern/products/asyncapi-def/pages/security-schemes/multiple-security-schemes.mdx @@ -2,6 +2,6 @@ title: Multiple Security Schemes --- -# Multiple Security Schemes +Learn how to define and use multiple security schemes in your OpenAPI definition. -Learn how to define and use multiple security schemes in your OpenAPI definition. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn). \ No newline at end of file diff --git a/fern/products/asyncapi-def/pages/security-schemes/overriding-security-scheme.mdx b/fern/products/asyncapi-def/pages/security-schemes/overriding-security-scheme.mdx index cf38307fc..a3c7c6bd7 100644 --- a/fern/products/asyncapi-def/pages/security-schemes/overriding-security-scheme.mdx +++ b/fern/products/asyncapi-def/pages/security-schemes/overriding-security-scheme.mdx @@ -1,7 +1,7 @@ --- -title: Overriding the Security Scheme +title: Overriding Security Scheme --- -# Overriding the Security Scheme +How to override security schemes in specific operations or contexts. -How to override the default security scheme in your OpenAPI definition. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn). \ No newline at end of file diff --git a/fern/products/asyncapi-def/pages/security-schemes/overview.mdx b/fern/products/asyncapi-def/pages/security-schemes/overview.mdx index c6be3e7c6..58347b318 100644 --- a/fern/products/asyncapi-def/pages/security-schemes/overview.mdx +++ b/fern/products/asyncapi-def/pages/security-schemes/overview.mdx @@ -2,6 +2,6 @@ title: Security Schemes Overview --- -# Security Schemes Overview +Overview of security schemes and authentication methods in OpenAPI. -An introduction to security schemes in OpenAPI. Learn about authentication and authorization options. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn). \ No newline at end of file diff --git a/fern/products/asyncapi-def/pages/servers/multiple-server-urls.mdx b/fern/products/asyncapi-def/pages/servers/multiple-server-urls.mdx index 4f563e0ef..9842ed0a3 100644 --- a/fern/products/asyncapi-def/pages/servers/multiple-server-urls.mdx +++ b/fern/products/asyncapi-def/pages/servers/multiple-server-urls.mdx @@ -2,6 +2,6 @@ title: Multiple Server URLs --- -# Multiple Server URLs +How to configure multiple server URLs for different environments. -How to define and use multiple server URLs in your OpenAPI definition. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn). \ No newline at end of file diff --git a/fern/products/asyncapi-def/pages/servers/naming-your-servers.mdx b/fern/products/asyncapi-def/pages/servers/naming-your-servers.mdx index ce65b26b6..a5d0d1172 100644 --- a/fern/products/asyncapi-def/pages/servers/naming-your-servers.mdx +++ b/fern/products/asyncapi-def/pages/servers/naming-your-servers.mdx @@ -2,6 +2,6 @@ title: Naming Your Servers --- -# Naming Your Servers +Best practices for naming your server configurations. -Best practices for naming your server URLs in OpenAPI. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn). \ No newline at end of file diff --git a/fern/products/asyncapi-def/pages/servers/overriding-servers.mdx b/fern/products/asyncapi-def/pages/servers/overriding-servers.mdx index 67ab82071..0b5ecad00 100644 --- a/fern/products/asyncapi-def/pages/servers/overriding-servers.mdx +++ b/fern/products/asyncapi-def/pages/servers/overriding-servers.mdx @@ -1,7 +1,7 @@ --- -title: Overriding the Servers +title: Overriding Servers --- -# Overriding the Servers +How to override server configurations in specific contexts. -How to override the default servers in your OpenAPI definition. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn). \ No newline at end of file diff --git a/fern/products/asyncapi-def/pages/servers/overview.mdx b/fern/products/asyncapi-def/pages/servers/overview.mdx index b45b551c9..4986039ff 100644 --- a/fern/products/asyncapi-def/pages/servers/overview.mdx +++ b/fern/products/asyncapi-def/pages/servers/overview.mdx @@ -2,6 +2,6 @@ title: Servers Overview --- -# Servers Overview +Overview of server configuration options in OpenAPI. -Introduction to server objects in OpenAPI. Learn how to define and manage server URLs. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn). \ No newline at end of file diff --git a/fern/products/docs/pages/changelog/overview.mdx b/fern/products/docs/pages/changelog/overview.mdx index 2782589d4..27a71b09e 100644 --- a/fern/products/docs/pages/changelog/overview.mdx +++ b/fern/products/docs/pages/changelog/overview.mdx @@ -2,6 +2,6 @@ title: Changelog Overview --- -# Changelog +Welcome to the changelog section. Here you can track all the updates and changes to the project. -Stay up to date with the latest changes and updates to your documentation site. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/docs/getting-started/overview). \ No newline at end of file diff --git a/fern/products/docs/pages/component-library/custom-components/custom-react-components.mdx b/fern/products/docs/pages/component-library/custom-components/custom-react-components.mdx index 47b7b83b0..29ad8f2e6 100644 --- a/fern/products/docs/pages/component-library/custom-components/custom-react-components.mdx +++ b/fern/products/docs/pages/component-library/custom-components/custom-react-components.mdx @@ -1,8 +1,8 @@ --- title: Custom React Components -description: Integrate your own React components into documentation. +description: How to create and use custom React components. --- -# Custom React Components +Learn how to integrate custom React components into your documentation. -You can integrate your own custom React components to extend the functionality of your documentation site. +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/docs/getting-started/overview). diff --git a/fern/products/docs/pages/component-library/custom-components/reusable-snippets.mdx b/fern/products/docs/pages/component-library/custom-components/reusable-snippets.mdx index 6b82300e6..88fbb3a8b 100644 --- a/fern/products/docs/pages/component-library/custom-components/reusable-snippets.mdx +++ b/fern/products/docs/pages/component-library/custom-components/reusable-snippets.mdx @@ -1,8 +1,8 @@ --- title: Reusable Snippets -description: Create and use reusable content snippets. +description: Creating and managing reusable content snippets. --- -# Reusable Snippets +Learn how to create and manage reusable content snippets for your documentation. -Reusable snippets let you define content once and use it in multiple places throughout your documentation. +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/docs/getting-started/overview). diff --git a/fern/products/docs/pages/component-library/default-components/accordion-groups.mdx b/fern/products/docs/pages/component-library/default-components/accordion-groups.mdx index 125ff555c..058d6a4f2 100644 --- a/fern/products/docs/pages/component-library/default-components/accordion-groups.mdx +++ b/fern/products/docs/pages/component-library/default-components/accordion-groups.mdx @@ -1,8 +1,8 @@ --- title: Accordion Groups -description: Group multiple accordions together for organized content. +description: How to use the Accordion Groups component. --- -# Accordion Groups +Documentation for the Accordion Groups component used to organize multiple collapsible sections together. -Accordion groups allow you to organize multiple accordions together for better structure. +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/docs/getting-started/overview). diff --git a/fern/products/docs/pages/component-library/default-components/accordions.mdx b/fern/products/docs/pages/component-library/default-components/accordions.mdx index 2030e173a..7e7f82b49 100644 --- a/fern/products/docs/pages/component-library/default-components/accordions.mdx +++ b/fern/products/docs/pages/component-library/default-components/accordions.mdx @@ -1,9 +1,9 @@ --- title: Accordions -description: Use accordions to show and hide content sections. +description: How to use the Accordions component. --- -# Accordions +Documentation for the Accordions component used to create collapsible sections that can show/hide content. -Accordions let you expand and collapse sections of content, making your documentation easier to navigate. +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/docs/getting-started/overview). diff --git a/fern/products/docs/pages/component-library/default-components/aside.mdx b/fern/products/docs/pages/component-library/default-components/aside.mdx index 0e4e57ce6..0a606e323 100644 --- a/fern/products/docs/pages/component-library/default-components/aside.mdx +++ b/fern/products/docs/pages/component-library/default-components/aside.mdx @@ -1,8 +1,8 @@ --- title: Aside -description: Highlight important information with the Aside component. +description: How to use the Aside component. --- -# Aside +Documentation for the Aside component used to display supplementary content or sidebars. -Use the Aside component to draw attention to important notes or tips in your documentation. +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/docs/getting-started/overview). diff --git a/fern/products/docs/pages/component-library/default-components/callouts.mdx b/fern/products/docs/pages/component-library/default-components/callouts.mdx index a443dc350..f95e34f93 100644 --- a/fern/products/docs/pages/component-library/default-components/callouts.mdx +++ b/fern/products/docs/pages/component-library/default-components/callouts.mdx @@ -1,8 +1,8 @@ --- title: Callouts -description: Use callouts to emphasize key information. +description: How to use the Callouts component. --- -# Callouts +Documentation for the Callouts component used to highlight important information, warnings, or tips. -Callouts are used to highlight warnings, tips, or other important information in your docs. +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/docs/getting-started/overview). diff --git a/fern/products/docs/pages/component-library/default-components/card-groups.mdx b/fern/products/docs/pages/component-library/default-components/card-groups.mdx index 3dae63b2c..0be37d7f8 100644 --- a/fern/products/docs/pages/component-library/default-components/card-groups.mdx +++ b/fern/products/docs/pages/component-library/default-components/card-groups.mdx @@ -1,8 +1,8 @@ --- title: Card Groups -description: Organize multiple cards together. +description: How to use the Card Groups component. --- -# Card Groups +Documentation for the Card Groups component used to organize multiple cards together. -Card groups help you organize multiple cards in a grid or row. +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/docs/getting-started/overview). diff --git a/fern/products/docs/pages/component-library/default-components/cards.mdx b/fern/products/docs/pages/component-library/default-components/cards.mdx index eddebd185..c8658706e 100644 --- a/fern/products/docs/pages/component-library/default-components/cards.mdx +++ b/fern/products/docs/pages/component-library/default-components/cards.mdx @@ -1,8 +1,8 @@ --- title: Cards -description: Display information in a card layout. +description: How to use the Cards component. --- -# Cards +Documentation for the Cards component used to display content in card-like containers. -Cards are useful for displaying information in a visually distinct container. +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/docs/getting-started/overview). diff --git a/fern/products/docs/pages/component-library/default-components/code-blocks.mdx b/fern/products/docs/pages/component-library/default-components/code-blocks.mdx index f53543909..709bee660 100644 --- a/fern/products/docs/pages/component-library/default-components/code-blocks.mdx +++ b/fern/products/docs/pages/component-library/default-components/code-blocks.mdx @@ -1,8 +1,8 @@ --- title: Code Blocks -description: Display code snippets with syntax highlighting. +description: How to use the Code Blocks component. --- -# Code Blocks +Documentation for the Code Blocks component used to display syntax-highlighted code snippets. -Use code blocks to show code examples with syntax highlighting for better readability. +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/docs/getting-started/overview). diff --git a/fern/products/docs/pages/component-library/default-components/embed.mdx b/fern/products/docs/pages/component-library/default-components/embed.mdx index 86361b447..3541b6e5d 100644 --- a/fern/products/docs/pages/component-library/default-components/embed.mdx +++ b/fern/products/docs/pages/component-library/default-components/embed.mdx @@ -1,8 +1,8 @@ --- title: Embed -description: Embed external content such as videos or iframes. +description: How to use the Embed component. --- -# Embed +Documentation for the Embed component used to embed external content like videos, widgets, or iframes. -The Embed component allows you to include external content like videos, maps, or iframes in your documentation. +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/docs/getting-started/overview). diff --git a/fern/products/docs/pages/component-library/default-components/endpoint-request-snippet.mdx b/fern/products/docs/pages/component-library/default-components/endpoint-request-snippet.mdx index 2e8fc2eb0..bb10c8361 100644 --- a/fern/products/docs/pages/component-library/default-components/endpoint-request-snippet.mdx +++ b/fern/products/docs/pages/component-library/default-components/endpoint-request-snippet.mdx @@ -1,8 +1,8 @@ --- title: Endpoint Request Snippet -description: Show example API request payloads. +description: How to use the Endpoint Request Snippet component. --- -# Endpoint Request Snippet +Documentation for the Endpoint Request Snippet component used to display API request examples and schemas. -Use this component to display example API request payloads for your endpoints. +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/docs/getting-started/overview). diff --git a/fern/products/docs/pages/component-library/default-components/endpoint-response-snippet.mdx b/fern/products/docs/pages/component-library/default-components/endpoint-response-snippet.mdx index 4df401294..087d970ce 100644 --- a/fern/products/docs/pages/component-library/default-components/endpoint-response-snippet.mdx +++ b/fern/products/docs/pages/component-library/default-components/endpoint-response-snippet.mdx @@ -1,8 +1,8 @@ --- title: Endpoint Response Snippet -description: Show example API response payloads. +description: How to use the Endpoint Response Snippet component. --- -# Endpoint Response Snippet +Documentation for the Endpoint Response Snippet component used to display API response examples and schemas. -Use this component to display example API response payloads for your endpoints. +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/docs/getting-started/overview). diff --git a/fern/products/docs/pages/component-library/default-components/endpoint-schema-snippet.mdx b/fern/products/docs/pages/component-library/default-components/endpoint-schema-snippet.mdx index 4b65ffce3..0b1229df9 100644 --- a/fern/products/docs/pages/component-library/default-components/endpoint-schema-snippet.mdx +++ b/fern/products/docs/pages/component-library/default-components/endpoint-schema-snippet.mdx @@ -1,8 +1,8 @@ --- title: Endpoint Schema Snippet -description: Show the schema for API endpoints. +description: How to use the Endpoint Schema Snippet component. --- -# Endpoint Schema Snippet +Documentation for the Endpoint Schema Snippet component used to display API endpoint schemas. -Use this component to display the schema for your API endpoints. +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/docs/getting-started/overview). diff --git a/fern/products/docs/pages/component-library/default-components/frames.mdx b/fern/products/docs/pages/component-library/default-components/frames.mdx index ac960baec..20ffae03c 100644 --- a/fern/products/docs/pages/component-library/default-components/frames.mdx +++ b/fern/products/docs/pages/component-library/default-components/frames.mdx @@ -1,8 +1,8 @@ --- title: Frames -description: Use frames to group related content visually. +description: How to use the Frames component. --- -# Frames +Documentation for the Frames component used to embed external content or create bordered sections. -Frames help you visually group related content in your documentation. +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/docs/getting-started/overview). diff --git a/fern/products/docs/pages/component-library/default-components/icons.mdx b/fern/products/docs/pages/component-library/default-components/icons.mdx index 352cd9d51..4b71645c2 100644 --- a/fern/products/docs/pages/component-library/default-components/icons.mdx +++ b/fern/products/docs/pages/component-library/default-components/icons.mdx @@ -1,8 +1,8 @@ --- title: Icons -description: Add icons to your documentation for visual cues. +description: How to use the Icons component. --- -# Icons +Documentation for the Icons component and available icon sets for use in your documentation. -Use icons to provide visual cues and enhance the appearance of your documentation. +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/docs/getting-started/overview). diff --git a/fern/products/docs/pages/component-library/default-components/overview.mdx b/fern/products/docs/pages/component-library/default-components/overview.mdx index 68c1ff944..366f47877 100644 --- a/fern/products/docs/pages/component-library/default-components/overview.mdx +++ b/fern/products/docs/pages/component-library/default-components/overview.mdx @@ -1,11 +1,11 @@ --- -title: Default Components +title: Default Components Overview description: Overview of the default components available. --- -# Default Components +Welcome to the Default Components section! Here you can find documentation for all the built-in components available for use in your project. -This section provides an overview of all the default components you can use in your documentation. +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/docs/getting-started/overview). diff --git a/fern/products/docs/pages/component-library/default-components/parameter-fields.mdx b/fern/products/docs/pages/component-library/default-components/parameter-fields.mdx index a2079193e..9fdc94bb0 100644 --- a/fern/products/docs/pages/component-library/default-components/parameter-fields.mdx +++ b/fern/products/docs/pages/component-library/default-components/parameter-fields.mdx @@ -1,8 +1,8 @@ --- title: Parameter Fields -description: Document API parameters with parameter fields. +description: How to use the Parameter Fields component. --- -# Parameter Fields +Documentation for the Parameter Fields component used to display API parameters and their descriptions. -Parameter fields help you document the parameters required by your API endpoints. +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/docs/getting-started/overview). diff --git a/fern/products/docs/pages/component-library/default-components/steps.mdx b/fern/products/docs/pages/component-library/default-components/steps.mdx index 27338fd40..bae50fa21 100644 --- a/fern/products/docs/pages/component-library/default-components/steps.mdx +++ b/fern/products/docs/pages/component-library/default-components/steps.mdx @@ -1,8 +1,8 @@ --- title: Steps -description: Show a sequence of steps for a process. +description: How to use the Steps component. --- -# Steps +Documentation for the Steps component used to create step-by-step guides. -Use the Steps component to guide users through a multi-step process. +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/docs/getting-started/overview). diff --git a/fern/products/docs/pages/component-library/default-components/tabs.mdx b/fern/products/docs/pages/component-library/default-components/tabs.mdx index 88f5c1e02..4a7973293 100644 --- a/fern/products/docs/pages/component-library/default-components/tabs.mdx +++ b/fern/products/docs/pages/component-library/default-components/tabs.mdx @@ -1,8 +1,8 @@ --- title: Tabs -description: Organize content into tabbed sections. +description: How to use the Tabs component. --- -# Tabs +Documentation for the Tabs component used to organize content into switchable sections. -Tabs allow you to organize related content into separate tabbed sections for easier navigation. +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/docs/getting-started/overview). diff --git a/fern/products/docs/pages/component-library/default-components/tooltips.mdx b/fern/products/docs/pages/component-library/default-components/tooltips.mdx index 4472b5365..4baaf946b 100644 --- a/fern/products/docs/pages/component-library/default-components/tooltips.mdx +++ b/fern/products/docs/pages/component-library/default-components/tooltips.mdx @@ -1,8 +1,8 @@ --- title: Tooltips -description: Provide additional information with tooltips. +description: How to use the Tooltips component. --- -# Tooltips +Documentation for the Tooltips component used to provide additional context on hover. -Tooltips display extra information when users hover over an element. +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/docs/getting-started/overview). diff --git a/fern/products/docs/pages/component-library/overview.mdx b/fern/products/docs/pages/component-library/overview.mdx index 0df9c6c76..e10915ac8 100644 --- a/fern/products/docs/pages/component-library/overview.mdx +++ b/fern/products/docs/pages/component-library/overview.mdx @@ -3,6 +3,6 @@ title: Component Library description: Overview of the available components in the library. --- -# Component Library +Welcome to the Component Library! Here you can find documentation and examples for all the reusable components available in this project. -Welcome to the Component Library! Here you can find documentation and examples for all the reusable components available in this project. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/docs/getting-started/overview). \ No newline at end of file diff --git a/fern/products/docs/pages/component-library/writing-content/frontmatter.mdx b/fern/products/docs/pages/component-library/writing-content/frontmatter.mdx index be5de95f4..fd588a140 100644 --- a/fern/products/docs/pages/component-library/writing-content/frontmatter.mdx +++ b/fern/products/docs/pages/component-library/writing-content/frontmatter.mdx @@ -1,9 +1,9 @@ --- title: Frontmatter -description: How to use frontmatter in your documentation pages. +description: Understanding and using frontmatter in your content. --- -# Frontmatter +Learn how to use frontmatter to add metadata and configuration to your content files. -Frontmatter is used to define metadata for your documentation pages, such as title, description, and more. +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/docs/getting-started/overview). diff --git a/fern/products/docs/pages/component-library/writing-content/markdown.mdx b/fern/products/docs/pages/component-library/writing-content/markdown.mdx index 91bd9be8e..3279e1ce8 100644 --- a/fern/products/docs/pages/component-library/writing-content/markdown.mdx +++ b/fern/products/docs/pages/component-library/writing-content/markdown.mdx @@ -1,27 +1,27 @@ --- title: Markdown -description: Learn how to use Markdown in your documentation. +description: Using Markdown for content creation. --- -# Markdown +Learn how to use Markdown syntax to create rich, formatted content for your documentation. -Markdown allows you to write rich content for your documentation using a simple, readable syntax. +Markdown is a lightweight markup language that allows you to add formatting to plain text documents. It's widely used for documentation because of its simplicity and readability. -## Example +## Basic Syntax -You can create headings, lists, code blocks, and more: +Here are some common Markdown elements: -### List Example -- Item 1 -- Item 2 -- Item 3 +- **Bold text**: `**bold**` +- *Italic text*: `*italic*` +- [Links](https://example.com): `[Links](https://example.com)` +- Lists: Use `-` or `*` for bullet points +- Code: Use backticks for `inline code` -### Code Block Example -```js -console.log('Hello, Markdown!'); -``` +## Advanced Features -> Markdown is easy to learn and powerful for documentation. +You can also use more advanced Markdown features like tables, code blocks, and more. + +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/docs/getting-started/overview). diff --git a/fern/products/docs/pages/component-library/writing-content/visual-editor.mdx b/fern/products/docs/pages/component-library/writing-content/visual-editor.mdx index cc556bb9b..2fb0a609b 100644 --- a/fern/products/docs/pages/component-library/writing-content/visual-editor.mdx +++ b/fern/products/docs/pages/component-library/writing-content/visual-editor.mdx @@ -1,9 +1,9 @@ --- title: Visual Editor -description: Using the visual editor to create and edit documentation content. +description: Using the visual editor for content creation. --- -# Visual Editor +Learn how to use the visual editor to create and edit content with a user-friendly interface. -The visual editor allows you to create and edit documentation content with a user-friendly interface. +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/docs/getting-started/overview). diff --git a/fern/products/docs/pages/guides/authentication/api-key-injection.mdx b/fern/products/docs/pages/guides/authentication/api-key-injection.mdx index aad0fc6e5..a47915e1c 100644 --- a/fern/products/docs/pages/guides/authentication/api-key-injection.mdx +++ b/fern/products/docs/pages/guides/authentication/api-key-injection.mdx @@ -2,6 +2,6 @@ title: API Key Injection --- -# API Key Injection +How to configure API key injection for authenticated documentation access. -How to inject API keys securely into your documentation or code samples. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/docs/getting-started/overview). \ No newline at end of file diff --git a/fern/products/docs/pages/guides/authentication/rbac.mdx b/fern/products/docs/pages/guides/authentication/rbac.mdx index d0de2a383..e805dff3d 100644 --- a/fern/products/docs/pages/guides/authentication/rbac.mdx +++ b/fern/products/docs/pages/guides/authentication/rbac.mdx @@ -1,7 +1,7 @@ --- -title: RBAC +title: Role-Based Access Control --- -# RBAC +How to implement role-based access control for your documentation. -How to set up Role-Based Access Control (RBAC) for your documentation site. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/docs/getting-started/overview). \ No newline at end of file diff --git a/fern/products/docs/pages/guides/authentication/sso.mdx b/fern/products/docs/pages/guides/authentication/sso.mdx index 69788a935..68d1ec574 100644 --- a/fern/products/docs/pages/guides/authentication/sso.mdx +++ b/fern/products/docs/pages/guides/authentication/sso.mdx @@ -1,7 +1,7 @@ --- -title: SSO +title: Single Sign-On --- -# SSO +How to configure Single Sign-On (SSO) for your documentation platform. -How to configure Single Sign-On (SSO) for your documentation site. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/docs/getting-started/overview). \ No newline at end of file diff --git a/fern/products/docs/pages/guides/enterprise/self-hosted.mdx b/fern/products/docs/pages/guides/enterprise/self-hosted.mdx index e583b3f36..262c636b5 100644 --- a/fern/products/docs/pages/guides/enterprise/self-hosted.mdx +++ b/fern/products/docs/pages/guides/enterprise/self-hosted.mdx @@ -1,7 +1,7 @@ --- -title: Self-hosted +title: Self-hosted Enterprise --- -# Self-hosted +Information about self-hosted enterprise solutions for your documentation platform. -Learn how to deploy and manage a self-hosted version of your documentation site. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/docs/getting-started/overview). \ No newline at end of file diff --git a/fern/products/docs/pages/guides/getting-started/customer-showcase.mdx b/fern/products/docs/pages/guides/getting-started/customer-showcase.mdx index d59532998..2d0ac3a8a 100644 --- a/fern/products/docs/pages/guides/getting-started/customer-showcase.mdx +++ b/fern/products/docs/pages/guides/getting-started/customer-showcase.mdx @@ -2,6 +2,6 @@ title: Customer Showcase --- -# Customer Showcase +Examples and case studies of customers using our documentation platform successfully. -See how other customers have successfully launched their documentation sites. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/docs/getting-started/overview). \ No newline at end of file diff --git a/fern/products/docs/pages/guides/getting-started/migrate-from-existing-site.mdx b/fern/products/docs/pages/guides/getting-started/migrate-from-existing-site.mdx index 99e8e8f8a..85cc0e968 100644 --- a/fern/products/docs/pages/guides/getting-started/migrate-from-existing-site.mdx +++ b/fern/products/docs/pages/guides/getting-started/migrate-from-existing-site.mdx @@ -1,7 +1,7 @@ --- -title: Migrate from an existing site +title: Migrate from Existing Site --- -# Migrate from an existing site +Step-by-step guide for migrating your documentation from an existing platform or static site. -Learn how to migrate your documentation from an existing site to this platform. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/docs/getting-started/overview). \ No newline at end of file diff --git a/fern/products/docs/pages/guides/getting-started/overview.mdx b/fern/products/docs/pages/guides/getting-started/overview.mdx index efbbecf44..653b332d3 100644 --- a/fern/products/docs/pages/guides/getting-started/overview.mdx +++ b/fern/products/docs/pages/guides/getting-started/overview.mdx @@ -2,6 +2,6 @@ title: Overview --- -# Overview +Welcome to the Getting Started guide! This page provides an introduction to setting up and using your documentation site. -Welcome to the Getting Started guide! This page provides an introduction to setting up and using your documentation site. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/docs/getting-started/overview). \ No newline at end of file diff --git a/fern/products/docs/pages/guides/getting-started/quickstart.mdx b/fern/products/docs/pages/guides/getting-started/quickstart.mdx index 76cb9fdec..2683ff3e7 100644 --- a/fern/products/docs/pages/guides/getting-started/quickstart.mdx +++ b/fern/products/docs/pages/guides/getting-started/quickstart.mdx @@ -2,6 +2,6 @@ title: Quickstart --- -# Quickstart +Get started quickly with our documentation platform in just a few steps. -Get up and running quickly with these simple steps to launch your documentation site. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/docs/getting-started/overview). \ No newline at end of file diff --git a/fern/products/docs/pages/guides/getting-started/setting-up-your-domain.mdx b/fern/products/docs/pages/guides/getting-started/setting-up-your-domain.mdx index 81e573134..5cb7e4f7b 100644 --- a/fern/products/docs/pages/guides/getting-started/setting-up-your-domain.mdx +++ b/fern/products/docs/pages/guides/getting-started/setting-up-your-domain.mdx @@ -1,7 +1,7 @@ --- -title: Setting up your domain +title: Setting Up Your Domain --- -# Setting up your domain +How to configure a custom domain for your documentation site. -Instructions for configuring your custom domain for the documentation site. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/docs/getting-started/overview). \ No newline at end of file diff --git a/fern/products/docs/pages/guides/integrations/analytics/fullstory.mdx b/fern/products/docs/pages/guides/integrations/analytics/fullstory.mdx index 499b7fbdb..9e856396c 100644 --- a/fern/products/docs/pages/guides/integrations/analytics/fullstory.mdx +++ b/fern/products/docs/pages/guides/integrations/analytics/fullstory.mdx @@ -1,7 +1,7 @@ --- -title: Fullstory +title: FullStory Analytics --- -# Fullstory +How to integrate FullStory session recording and analytics into your documentation. -How to integrate Fullstory analytics with your documentation site. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/docs/getting-started/overview). \ No newline at end of file diff --git a/fern/products/docs/pages/guides/integrations/analytics/google.mdx b/fern/products/docs/pages/guides/integrations/analytics/google.mdx index 6cc895da4..03f484b4b 100644 --- a/fern/products/docs/pages/guides/integrations/analytics/google.mdx +++ b/fern/products/docs/pages/guides/integrations/analytics/google.mdx @@ -2,6 +2,6 @@ title: Google Analytics --- -# Google Analytics +How to integrate Google Analytics into your documentation to track visitor behavior. -How to integrate Google Analytics with your documentation site. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/docs/getting-started/overview). \ No newline at end of file diff --git a/fern/products/docs/pages/guides/integrations/analytics/posthog.mdx b/fern/products/docs/pages/guides/integrations/analytics/posthog.mdx index 1307b20d9..381242b1f 100644 --- a/fern/products/docs/pages/guides/integrations/analytics/posthog.mdx +++ b/fern/products/docs/pages/guides/integrations/analytics/posthog.mdx @@ -1,7 +1,7 @@ --- -title: PostHog +title: PostHog Analytics --- -# PostHog +How to integrate PostHog analytics into your documentation. -How to integrate PostHog analytics with your documentation site. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/docs/getting-started/overview). \ No newline at end of file diff --git a/fern/products/docs/pages/guides/integrations/analytics/segment.mdx b/fern/products/docs/pages/guides/integrations/analytics/segment.mdx index ae291ba3a..78226f90d 100644 --- a/fern/products/docs/pages/guides/integrations/analytics/segment.mdx +++ b/fern/products/docs/pages/guides/integrations/analytics/segment.mdx @@ -1,7 +1,7 @@ --- -title: Segment +title: Segment Analytics --- -# Segment +How to integrate Segment analytics into your documentation. -How to integrate Segment analytics with your documentation site. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/docs/getting-started/overview). \ No newline at end of file diff --git a/fern/products/docs/pages/guides/integrations/feature-flags.mdx b/fern/products/docs/pages/guides/integrations/feature-flags.mdx index 6358e2df6..79220f50a 100644 --- a/fern/products/docs/pages/guides/integrations/feature-flags.mdx +++ b/fern/products/docs/pages/guides/integrations/feature-flags.mdx @@ -2,6 +2,6 @@ title: Feature Flags --- -# Feature Flags +How to implement and manage feature flags in your documentation. -How to use feature flags in your documentation site. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/docs/getting-started/overview). \ No newline at end of file diff --git a/fern/products/docs/pages/guides/integrations/postman.mdx b/fern/products/docs/pages/guides/integrations/postman.mdx index 7d8440df6..32038079f 100644 --- a/fern/products/docs/pages/guides/integrations/postman.mdx +++ b/fern/products/docs/pages/guides/integrations/postman.mdx @@ -1,7 +1,7 @@ --- -title: Postman +title: Postman Integration --- -# Postman +How to integrate Postman collections with your documentation. -How to integrate Postman collections with your documentation site. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/docs/getting-started/overview). \ No newline at end of file diff --git a/fern/products/docs/pages/guides/integrations/self-hosted.mdx b/fern/products/docs/pages/guides/integrations/self-hosted.mdx index e4e8c10c3..79dc013b0 100644 --- a/fern/products/docs/pages/guides/integrations/self-hosted.mdx +++ b/fern/products/docs/pages/guides/integrations/self-hosted.mdx @@ -1,7 +1,7 @@ --- -title: Self-hosted (Integrations) +title: Self-hosted Integrations --- -# Self-hosted (Integrations) +Learn how to set up and configure self-hosted integrations for your documentation. -How to integrate with self-hosted analytics or support tools. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/docs/getting-started/overview). \ No newline at end of file diff --git a/fern/products/docs/pages/guides/integrations/support/postman.mdx b/fern/products/docs/pages/guides/integrations/support/postman.mdx index 53b15dfc2..56ed89e5d 100644 --- a/fern/products/docs/pages/guides/integrations/support/postman.mdx +++ b/fern/products/docs/pages/guides/integrations/support/postman.mdx @@ -1,7 +1,7 @@ --- -title: Postman (Support) +title: Postman Support --- -# Postman (Support) +Support resources for Postman integration issues and troubleshooting. -How to use Postman for supporting your API documentation users. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/docs/getting-started/overview). \ No newline at end of file diff --git a/fern/products/docs/pages/guides/navigation/api-references.mdx b/fern/products/docs/pages/guides/navigation/api-references.mdx index 399cf06e5..9de914005 100644 --- a/fern/products/docs/pages/guides/navigation/api-references.mdx +++ b/fern/products/docs/pages/guides/navigation/api-references.mdx @@ -2,6 +2,6 @@ title: API References --- -# API References +How to organize and structure API reference documentation in your navigation. -How to include and organize API reference documentation in your site. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/docs/getting-started/overview). \ No newline at end of file diff --git a/fern/products/docs/pages/guides/navigation/changelogs.mdx b/fern/products/docs/pages/guides/navigation/changelogs.mdx index 50a2beb3f..fa8bf8acf 100644 --- a/fern/products/docs/pages/guides/navigation/changelogs.mdx +++ b/fern/products/docs/pages/guides/navigation/changelogs.mdx @@ -2,6 +2,6 @@ title: Changelogs --- -# Changelogs +How to organize and display changelogs in your documentation navigation. -Learn how to add and manage changelogs for your products and documentation. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/docs/getting-started/overview). \ No newline at end of file diff --git a/fern/products/docs/pages/guides/navigation/hiding-content.mdx b/fern/products/docs/pages/guides/navigation/hiding-content.mdx index ab2936a4e..5856789a7 100644 --- a/fern/products/docs/pages/guides/navigation/hiding-content.mdx +++ b/fern/products/docs/pages/guides/navigation/hiding-content.mdx @@ -2,6 +2,6 @@ title: Hiding Content --- -# Hiding Content +How to hide specific content sections or pages from navigation while keeping them accessible. -Instructions for hiding or restricting access to certain documentation content. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/docs/getting-started/overview). \ No newline at end of file diff --git a/fern/products/docs/pages/guides/navigation/overview.mdx b/fern/products/docs/pages/guides/navigation/overview.mdx index 6489b7f0d..3601099ac 100644 --- a/fern/products/docs/pages/guides/navigation/overview.mdx +++ b/fern/products/docs/pages/guides/navigation/overview.mdx @@ -1,7 +1,7 @@ --- -title: Overview +title: Navigation Overview --- -# Navigation Overview +Overview of navigation options and configuration for your documentation site. -This page provides an overview of navigation options in your documentation site. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/docs/getting-started/overview). \ No newline at end of file diff --git a/fern/products/docs/pages/guides/navigation/products.mdx b/fern/products/docs/pages/guides/navigation/products.mdx index 22363adf7..8a4f7af1f 100644 --- a/fern/products/docs/pages/guides/navigation/products.mdx +++ b/fern/products/docs/pages/guides/navigation/products.mdx @@ -2,6 +2,6 @@ title: Products --- -# Products +How to organize multiple products in your documentation navigation structure. -How to organize and present multiple products within your documentation site. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/docs/getting-started/overview). \ No newline at end of file diff --git a/fern/products/docs/pages/guides/navigation/tabs.mdx b/fern/products/docs/pages/guides/navigation/tabs.mdx index b9dfd715a..8a2523c1d 100644 --- a/fern/products/docs/pages/guides/navigation/tabs.mdx +++ b/fern/products/docs/pages/guides/navigation/tabs.mdx @@ -1,7 +1,7 @@ --- -title: Tabs +title: Navigation Tabs --- -# Tabs +How to configure and use navigation tabs in your documentation structure. -Learn how to use and configure tabs for organizing your documentation content. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/docs/getting-started/overview). \ No newline at end of file diff --git a/fern/products/docs/pages/guides/navigation/versions.mdx b/fern/products/docs/pages/guides/navigation/versions.mdx index 066f0ad5c..c860fc2c7 100644 --- a/fern/products/docs/pages/guides/navigation/versions.mdx +++ b/fern/products/docs/pages/guides/navigation/versions.mdx @@ -2,6 +2,6 @@ title: Versions --- -# Versions +How to manage and display different versions of your documentation in navigation. -Instructions for managing and displaying different versions of your documentation. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/docs/getting-started/overview). \ No newline at end of file diff --git a/fern/products/docs/pages/guides/reference/frontmatter.mdx b/fern/products/docs/pages/guides/reference/frontmatter.mdx index cc30d093c..6658a8812 100644 --- a/fern/products/docs/pages/guides/reference/frontmatter.mdx +++ b/fern/products/docs/pages/guides/reference/frontmatter.mdx @@ -1,7 +1,7 @@ --- -title: Frontmatter +title: Frontmatter Reference --- -# Frontmatter +Complete reference guide for frontmatter options and configuration in your documentation. -Learn about the frontmatter block at the top of your MDX files and how to use it effectively. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/docs/getting-started/overview). \ No newline at end of file diff --git a/fern/products/docs/pages/guides/reference/what-is-docs-yml.mdx b/fern/products/docs/pages/guides/reference/what-is-docs-yml.mdx index 91dd49321..946224d6b 100644 --- a/fern/products/docs/pages/guides/reference/what-is-docs-yml.mdx +++ b/fern/products/docs/pages/guides/reference/what-is-docs-yml.mdx @@ -1,7 +1,7 @@ --- -title: What is docs.yml +title: What is docs.yml? --- -# What is docs.yml +Understanding the docs.yml configuration file and how it controls your documentation structure. -An overview of the docs.yml configuration file and its role in your documentation project. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/docs/getting-started/overview). \ No newline at end of file diff --git a/fern/products/docs/pages/guides/seo/configuring-slugs.mdx b/fern/products/docs/pages/guides/seo/configuring-slugs.mdx index 23a1a37f1..e6cf23a18 100644 --- a/fern/products/docs/pages/guides/seo/configuring-slugs.mdx +++ b/fern/products/docs/pages/guides/seo/configuring-slugs.mdx @@ -2,6 +2,6 @@ title: Configuring Slugs --- -# Configuring Slugs +How to configure custom URL slugs for your documentation pages for better SEO. -How to configure URL slugs for your documentation pages. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/docs/getting-started/overview). \ No newline at end of file diff --git a/fern/products/docs/pages/guides/seo/ilms-txt.mdx b/fern/products/docs/pages/guides/seo/ilms-txt.mdx index a568dd9eb..56bb403fa 100644 --- a/fern/products/docs/pages/guides/seo/ilms-txt.mdx +++ b/fern/products/docs/pages/guides/seo/ilms-txt.mdx @@ -1,7 +1,7 @@ --- -title: Ilms.txt +title: ILMS.txt --- -# Ilms.txt +How to configure ILMS.txt files for search engine optimization. -Information about the Ilms.txt file and its usage for SEO. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/docs/getting-started/overview). \ No newline at end of file diff --git a/fern/products/docs/pages/guides/seo/redirects.mdx b/fern/products/docs/pages/guides/seo/redirects.mdx index 5dbb04e2f..f28abd195 100644 --- a/fern/products/docs/pages/guides/seo/redirects.mdx +++ b/fern/products/docs/pages/guides/seo/redirects.mdx @@ -2,6 +2,6 @@ title: Redirects --- -# Redirects +How to set up and manage redirects for your documentation URLs. -Learn how to set up redirects for your documentation site. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/docs/getting-started/overview). \ No newline at end of file diff --git a/fern/products/docs/pages/guides/seo/seo-metadata.mdx b/fern/products/docs/pages/guides/seo/seo-metadata.mdx index 113a00c1e..ac315e6ce 100644 --- a/fern/products/docs/pages/guides/seo/seo-metadata.mdx +++ b/fern/products/docs/pages/guides/seo/seo-metadata.mdx @@ -2,6 +2,6 @@ title: SEO Metadata --- -# SEO Metadata +How to optimize your documentation with proper SEO metadata for better search rankings. -How to add and manage SEO metadata for your documentation pages. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/docs/getting-started/overview). \ No newline at end of file diff --git a/fern/products/fern-def/pages/defining-your-api/audiences.mdx b/fern/products/fern-def/pages/defining-your-api/audiences.mdx index 11d55798b..27a9a970f 100644 --- a/fern/products/fern-def/pages/defining-your-api/audiences.mdx +++ b/fern/products/fern-def/pages/defining-your-api/audiences.mdx @@ -2,6 +2,6 @@ title: Audiences --- -# Audiences +Define different audiences for your API. -Details about different audiences or user groups for the API. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/api-definition/fern/overview). \ No newline at end of file diff --git a/fern/products/fern-def/pages/defining-your-api/availability.mdx b/fern/products/fern-def/pages/defining-your-api/availability.mdx index cab7f2bd0..2fdc73302 100644 --- a/fern/products/fern-def/pages/defining-your-api/availability.mdx +++ b/fern/products/fern-def/pages/defining-your-api/availability.mdx @@ -2,6 +2,6 @@ title: Availability --- -# Availability +Configure availability settings for your API. -Information about the availability and uptime of the API. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/api-definition/fern/overview). \ No newline at end of file diff --git a/fern/products/fern-def/pages/defining-your-api/doc.mdx b/fern/products/fern-def/pages/defining-your-api/doc.mdx index 949f93a49..4f467bad4 100644 --- a/fern/products/fern-def/pages/defining-your-api/doc.mdx +++ b/fern/products/fern-def/pages/defining-your-api/doc.mdx @@ -2,6 +2,6 @@ title: Doc --- -# Doc +Documentation configuration. -General documentation for your API. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/api-definition/fern/overview). \ No newline at end of file diff --git a/fern/products/fern-def/pages/defining-your-api/endpoints.mdx b/fern/products/fern-def/pages/defining-your-api/endpoints.mdx index ec000c42f..8a40e2430 100644 --- a/fern/products/fern-def/pages/defining-your-api/endpoints.mdx +++ b/fern/products/fern-def/pages/defining-your-api/endpoints.mdx @@ -2,6 +2,6 @@ title: Endpoints --- -# Endpoints +How to define API endpoints in your specification. -A list and description of all available API endpoints. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/api-definition/fern/overview). \ No newline at end of file diff --git a/fern/products/fern-def/pages/defining-your-api/errors.mdx b/fern/products/fern-def/pages/defining-your-api/errors.mdx index 2310d891d..3bd416a65 100644 --- a/fern/products/fern-def/pages/defining-your-api/errors.mdx +++ b/fern/products/fern-def/pages/defining-your-api/errors.mdx @@ -2,6 +2,6 @@ title: Errors --- -# Errors +Define error responses for your API. -Common errors and how to handle them. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/api-definition/fern/overview). \ No newline at end of file diff --git a/fern/products/fern-def/pages/defining-your-api/examples.mdx b/fern/products/fern-def/pages/defining-your-api/examples.mdx index 94c010d53..057f09c6b 100644 --- a/fern/products/fern-def/pages/defining-your-api/examples.mdx +++ b/fern/products/fern-def/pages/defining-your-api/examples.mdx @@ -2,6 +2,6 @@ title: Examples --- -# Examples +How to add examples to your API definition. -Code samples and example requests/responses for the API. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/api-definition/fern/overview). \ No newline at end of file diff --git a/fern/products/fern-def/pages/defining-your-api/imports.mdx b/fern/products/fern-def/pages/defining-your-api/imports.mdx index fe7cb9f9e..2e72db4d0 100644 --- a/fern/products/fern-def/pages/defining-your-api/imports.mdx +++ b/fern/products/fern-def/pages/defining-your-api/imports.mdx @@ -2,6 +2,6 @@ title: Imports --- -# Imports +How to import external definitions into your API. -How to import and reuse components in your API definition. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/api-definition/fern/overview). \ No newline at end of file diff --git a/fern/products/fern-def/pages/defining-your-api/types.mdx b/fern/products/fern-def/pages/defining-your-api/types.mdx index db68cc8eb..b9611b38b 100644 --- a/fern/products/fern-def/pages/defining-your-api/types.mdx +++ b/fern/products/fern-def/pages/defining-your-api/types.mdx @@ -2,6 +2,6 @@ title: Types --- -# Types +Documentation on the data types used in the API. -Documentation on the data types used in the API. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/api-definition/fern/overview). \ No newline at end of file diff --git a/fern/products/fern-def/pages/defining-your-api/webhooks.mdx b/fern/products/fern-def/pages/defining-your-api/webhooks.mdx index ea2a23793..e1144b2b5 100644 --- a/fern/products/fern-def/pages/defining-your-api/webhooks.mdx +++ b/fern/products/fern-def/pages/defining-your-api/webhooks.mdx @@ -2,6 +2,6 @@ title: Webhooks --- -# Webhooks +How to define webhook endpoints in your API. -Information about webhook support and configuration. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/api-definition/fern/overview). \ No newline at end of file diff --git a/fern/products/fern-def/pages/defining-your-api/websockets.mdx b/fern/products/fern-def/pages/defining-your-api/websockets.mdx index c568ce29f..23d62baa9 100644 --- a/fern/products/fern-def/pages/defining-your-api/websockets.mdx +++ b/fern/products/fern-def/pages/defining-your-api/websockets.mdx @@ -2,6 +2,6 @@ title: WebSockets --- -# WebSockets +Configure WebSocket connections in your API. -Details on using WebSockets with the API. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/api-definition/fern/overview). \ No newline at end of file diff --git a/fern/products/fern-def/pages/getting-started/customer-showcase.mdx b/fern/products/fern-def/pages/getting-started/customer-showcase.mdx index 320ec6b7d..6084c326c 100644 --- a/fern/products/fern-def/pages/getting-started/customer-showcase.mdx +++ b/fern/products/fern-def/pages/getting-started/customer-showcase.mdx @@ -1,7 +1,7 @@ --- -title: Customer Showcase +title: Customer showcase --- -# Customer Showcase +See how other customers are using Fern successfully. -See how customers are using our API to build amazing products. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/api-definition/fern/overview). \ No newline at end of file diff --git a/fern/products/fern-def/pages/getting-started/overview.mdx b/fern/products/fern-def/pages/getting-started/overview.mdx index 41b0cc32a..df0f4cb1f 100644 --- a/fern/products/fern-def/pages/getting-started/overview.mdx +++ b/fern/products/fern-def/pages/getting-started/overview.mdx @@ -2,6 +2,6 @@ title: Overview --- -# Overview +Welcome to the Getting Started section! This page provides an introduction to the API and how to begin using it. -Welcome to the Getting Started section! This page provides an introduction to the API and how to begin using it. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/api-definition/fern/overview). \ No newline at end of file diff --git a/fern/products/fern-def/pages/getting-started/philosophy.mdx b/fern/products/fern-def/pages/getting-started/philosophy.mdx index d12a25a0e..5202a8997 100644 --- a/fern/products/fern-def/pages/getting-started/philosophy.mdx +++ b/fern/products/fern-def/pages/getting-started/philosophy.mdx @@ -2,6 +2,6 @@ title: Philosophy --- -# Philosophy +The principles and philosophy behind Fern API definitions. -Learn about the guiding principles and philosophy behind our API design. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/api-definition/fern/overview). \ No newline at end of file diff --git a/fern/products/fern-def/pages/getting-started/quickstart.mdx b/fern/products/fern-def/pages/getting-started/quickstart.mdx index e01b30d48..d789ff993 100644 --- a/fern/products/fern-def/pages/getting-started/quickstart.mdx +++ b/fern/products/fern-def/pages/getting-started/quickstart.mdx @@ -2,6 +2,6 @@ title: Quickstart --- -# Quickstart +Get started with Fern quickly with this guide. -Follow these steps to quickly get up and running with the API. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/api-definition/fern/overview). \ No newline at end of file diff --git a/fern/products/fern-def/pages/global-settings/api-versions.mdx b/fern/products/fern-def/pages/global-settings/api-versions.mdx index 5b323c02c..72af50968 100644 --- a/fern/products/fern-def/pages/global-settings/api-versions.mdx +++ b/fern/products/fern-def/pages/global-settings/api-versions.mdx @@ -1,7 +1,7 @@ --- -title: API Versions +title: API versions --- -# API Versions +How to manage different versions of your API. -Learn about versioning and how to select the appropriate API version. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/api-definition/fern/overview). \ No newline at end of file diff --git a/fern/products/fern-def/pages/global-settings/authentication.mdx b/fern/products/fern-def/pages/global-settings/authentication.mdx index 479401d42..a62c4dfbb 100644 --- a/fern/products/fern-def/pages/global-settings/authentication.mdx +++ b/fern/products/fern-def/pages/global-settings/authentication.mdx @@ -2,6 +2,6 @@ title: Authentication --- -# Authentication +Configure authentication methods for your API. -Learn how to authenticate with the API and manage credentials. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/api-definition/fern/overview). \ No newline at end of file diff --git a/fern/products/fern-def/pages/global-settings/environments.mdx b/fern/products/fern-def/pages/global-settings/environments.mdx index e24c1f696..dd4106bef 100644 --- a/fern/products/fern-def/pages/global-settings/environments.mdx +++ b/fern/products/fern-def/pages/global-settings/environments.mdx @@ -2,6 +2,6 @@ title: Environments --- -# Environments +Configure different environments for your API (development, staging, production). -Details about the different environments available for the API (e.g., production, staging). \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/api-definition/fern/overview). \ No newline at end of file diff --git a/fern/products/fern-def/pages/global-settings/global-headers.mdx b/fern/products/fern-def/pages/global-settings/global-headers.mdx index 168b028f1..bcc581902 100644 --- a/fern/products/fern-def/pages/global-settings/global-headers.mdx +++ b/fern/products/fern-def/pages/global-settings/global-headers.mdx @@ -1,7 +1,7 @@ --- -title: Global Headers +title: Global headers --- -# Global Headers +Define headers that apply to all API endpoints. -Information about required and optional global headers for API requests. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/api-definition/fern/overview). \ No newline at end of file diff --git a/fern/products/fern-def/pages/guides/creating-namespaces.mdx b/fern/products/fern-def/pages/guides/creating-namespaces.mdx index 6571b3666..ed970b397 100644 --- a/fern/products/fern-def/pages/guides/creating-namespaces.mdx +++ b/fern/products/fern-def/pages/guides/creating-namespaces.mdx @@ -2,6 +2,6 @@ title: Creating namespaces --- -# Creating namespaces +Instructions for creating and organizing namespaces in your API. -Instructions for creating and organizing namespaces in your API. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/api-definition/fern/overview). \ No newline at end of file diff --git a/fern/products/fern-def/pages/guides/define-multiple-apis.mdx b/fern/products/fern-def/pages/guides/define-multiple-apis.mdx index 03adf17c7..57c6b7543 100644 --- a/fern/products/fern-def/pages/guides/define-multiple-apis.mdx +++ b/fern/products/fern-def/pages/guides/define-multiple-apis.mdx @@ -2,6 +2,6 @@ title: Define multiple APIs --- -# Define multiple APIs +How to define and manage multiple APIs in one project. -Instructions for defining and managing multiple APIs. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/api-definition/fern/overview). \ No newline at end of file diff --git a/fern/products/fern-def/pages/guides/depending-on-other-apis.mdx b/fern/products/fern-def/pages/guides/depending-on-other-apis.mdx index 47501b54a..e92b4376d 100644 --- a/fern/products/fern-def/pages/guides/depending-on-other-apis.mdx +++ b/fern/products/fern-def/pages/guides/depending-on-other-apis.mdx @@ -2,6 +2,6 @@ title: Depending on other APIs --- -# Depending on other APIs +How to manage dependencies between different APIs. -How to depend on and integrate with other APIs. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/api-definition/fern/overview). \ No newline at end of file diff --git a/fern/products/fern-def/pages/guides/export-to-openapi.mdx b/fern/products/fern-def/pages/guides/export-to-openapi.mdx index bc7b5c797..a3f85ef9c 100644 --- a/fern/products/fern-def/pages/guides/export-to-openapi.mdx +++ b/fern/products/fern-def/pages/guides/export-to-openapi.mdx @@ -2,6 +2,6 @@ title: Export to OpenAPI --- -# Export to OpenAPI +How to export your API definition to OpenAPI format. -How to export your Fern API definition to OpenAPI format. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/api-definition/fern/overview). \ No newline at end of file diff --git a/fern/products/fern-def/pages/guides/validate-your-fern-definition.mdx b/fern/products/fern-def/pages/guides/validate-your-fern-definition.mdx index 952fddedd..07b6d978e 100644 --- a/fern/products/fern-def/pages/guides/validate-your-fern-definition.mdx +++ b/fern/products/fern-def/pages/guides/validate-your-fern-definition.mdx @@ -1,7 +1,7 @@ --- -title: Validate your Fern Definition +title: Validate your Fern definition --- -# Validate your Fern Definition +Learn how to validate your Fern definition to ensure it's correct. -How to validate your Fern API definition for correctness. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/api-definition/fern/overview). \ No newline at end of file diff --git a/fern/products/grpc-def/pages/getting-started/customer-showcase.mdx b/fern/products/grpc-def/pages/getting-started/customer-showcase.mdx index b8913aadc..662e99e15 100644 --- a/fern/products/grpc-def/pages/getting-started/customer-showcase.mdx +++ b/fern/products/grpc-def/pages/getting-started/customer-showcase.mdx @@ -2,6 +2,6 @@ title: Customer Showcase --- -# Customer Showcase +Examples and case studies of customers using AsyncAPI definitions successfully. -See how other customers are using OpenAPI definitions to power their APIs and documentation. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/api-definition/introduction/what-is-an-api-definition). \ No newline at end of file diff --git a/fern/products/grpc-def/pages/getting-started/get-to-openapi.mdx b/fern/products/grpc-def/pages/getting-started/get-to-openapi.mdx index 65cd466c8..6a181a5a0 100644 --- a/fern/products/grpc-def/pages/getting-started/get-to-openapi.mdx +++ b/fern/products/grpc-def/pages/getting-started/get-to-openapi.mdx @@ -2,6 +2,6 @@ title: Get to OpenAPI --- -# Get to OpenAPI +How to transition from AsyncAPI to OpenAPI or integrate both specifications. -Learn how to create or obtain your OpenAPI definition. Explore different approaches including handwriting, generating from code, and more. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/api-definition/introduction/what-is-an-api-definition). \ No newline at end of file diff --git a/fern/products/grpc-def/pages/getting-started/get-to-openapi/generate-it/fastapi.mdx b/fern/products/grpc-def/pages/getting-started/get-to-openapi/generate-it/fastapi.mdx index c8095e8a7..0bd4dc599 100644 --- a/fern/products/grpc-def/pages/getting-started/get-to-openapi/generate-it/fastapi.mdx +++ b/fern/products/grpc-def/pages/getting-started/get-to-openapi/generate-it/fastapi.mdx @@ -2,6 +2,6 @@ title: FastAPI --- -# Generate OpenAPI from FastAPI +Instructions for generating an OpenAPI definition from a FastAPI project. -Instructions for generating an OpenAPI definition from a FastAPI project. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/api-definition/introduction/what-is-an-api-definition). \ No newline at end of file diff --git a/fern/products/grpc-def/pages/getting-started/get-to-openapi/generate-it/nestjs.mdx b/fern/products/grpc-def/pages/getting-started/get-to-openapi/generate-it/nestjs.mdx index dfefb49b9..b40a35e56 100644 --- a/fern/products/grpc-def/pages/getting-started/get-to-openapi/generate-it/nestjs.mdx +++ b/fern/products/grpc-def/pages/getting-started/get-to-openapi/generate-it/nestjs.mdx @@ -2,6 +2,6 @@ title: NestJS --- -# Generate OpenAPI from NestJS +Instructions for generating an OpenAPI definition from a NestJS project. -Instructions for generating an OpenAPI definition from a NestJS project. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/api-definition/introduction/what-is-an-api-definition). \ No newline at end of file diff --git a/fern/products/grpc-def/pages/getting-started/get-to-openapi/generate-it/request-new-framework.mdx b/fern/products/grpc-def/pages/getting-started/get-to-openapi/generate-it/request-new-framework.mdx index 2daa88917..3df1b9d6b 100644 --- a/fern/products/grpc-def/pages/getting-started/get-to-openapi/generate-it/request-new-framework.mdx +++ b/fern/products/grpc-def/pages/getting-started/get-to-openapi/generate-it/request-new-framework.mdx @@ -1,7 +1,7 @@ --- -title: Request a new framework +title: Request New Framework --- -# Request a New Framework +Don't see your framework? Let us know which framework you'd like to see supported for OpenAPI generation. -Don't see your framework? Let us know which framework you'd like to see supported for OpenAPI generation. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/api-definition/introduction/what-is-an-api-definition). \ No newline at end of file diff --git a/fern/products/grpc-def/pages/getting-started/get-to-openapi/generate-it/swaggo.mdx b/fern/products/grpc-def/pages/getting-started/get-to-openapi/generate-it/swaggo.mdx index 5512b276a..2dfadfb00 100644 --- a/fern/products/grpc-def/pages/getting-started/get-to-openapi/generate-it/swaggo.mdx +++ b/fern/products/grpc-def/pages/getting-started/get-to-openapi/generate-it/swaggo.mdx @@ -2,6 +2,6 @@ title: Swaggo --- -# Generate OpenAPI from Swaggo +Instructions for generating an OpenAPI definition from a Swaggo (Go) project. -Instructions for generating an OpenAPI definition from a Swaggo (Go) project. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/api-definition/introduction/what-is-an-api-definition). \ No newline at end of file diff --git a/fern/products/grpc-def/pages/getting-started/get-to-openapi/handwrite-it.mdx b/fern/products/grpc-def/pages/getting-started/get-to-openapi/handwrite-it.mdx index 6db37bb5b..5555fe1f5 100644 --- a/fern/products/grpc-def/pages/getting-started/get-to-openapi/handwrite-it.mdx +++ b/fern/products/grpc-def/pages/getting-started/get-to-openapi/handwrite-it.mdx @@ -1,7 +1,7 @@ --- -title: Handwrite it +title: Handwrite It --- -# Handwrite Your OpenAPI Definition +Step-by-step guide to manually writing your OpenAPI definition from scratch. -Step-by-step guide to manually writing your OpenAPI definition from scratch. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/api-definition/introduction/what-is-an-api-definition). \ No newline at end of file diff --git a/fern/products/grpc-def/pages/getting-started/overlay-customizations.mdx b/fern/products/grpc-def/pages/getting-started/overlay-customizations.mdx index 26b75af7e..6fb9aad86 100644 --- a/fern/products/grpc-def/pages/getting-started/overlay-customizations.mdx +++ b/fern/products/grpc-def/pages/getting-started/overlay-customizations.mdx @@ -1,7 +1,7 @@ --- -title: Overlay customizations +title: Overlay Customizations --- -# Overlay Customizations +Learn how to customize your OpenAPI overlays to fit your unique requirements. -Learn how to customize your OpenAPI overlays to fit your unique requirements. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/api-definition/introduction/what-is-an-api-definition). \ No newline at end of file diff --git a/fern/products/grpc-def/pages/getting-started/overview.mdx b/fern/products/grpc-def/pages/getting-started/overview.mdx index 001442f88..1c576e43b 100644 --- a/fern/products/grpc-def/pages/getting-started/overview.mdx +++ b/fern/products/grpc-def/pages/getting-started/overview.mdx @@ -2,6 +2,6 @@ title: Overview --- -# Overview +This is the overview page for Getting Started with your OpenAPI definition. Here you will find a high-level introduction and guidance on how to begin. -This is the overview page for Getting Started with your OpenAPI definition. Here you will find a high-level introduction and guidance on how to begin. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/api-definition/introduction/what-is-an-api-definition). \ No newline at end of file diff --git a/fern/products/grpc-def/pages/getting-started/philosophy.mdx b/fern/products/grpc-def/pages/getting-started/philosophy.mdx index 56f5a3b9a..0e52bc615 100644 --- a/fern/products/grpc-def/pages/getting-started/philosophy.mdx +++ b/fern/products/grpc-def/pages/getting-started/philosophy.mdx @@ -2,6 +2,6 @@ title: Philosophy --- -# Philosophy +The philosophy and principles behind AsyncAPI definitions and how they enhance API development. -Understand the philosophy behind designing and maintaining your OpenAPI definitions. Learn best practices and guiding principles. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/api-definition/introduction/what-is-an-api-definition). \ No newline at end of file diff --git a/fern/products/grpc-def/pages/schemas/allof.mdx b/fern/products/grpc-def/pages/schemas/allof.mdx index b2df5b757..305b424b5 100644 --- a/fern/products/grpc-def/pages/schemas/allof.mdx +++ b/fern/products/grpc-def/pages/schemas/allof.mdx @@ -1,7 +1,7 @@ --- -title: AllOf +title: All Of --- -# AllOf +How to use the `allOf` keyword to compose schemas in OpenAPI. -How to use the `allOf` keyword to compose schemas in OpenAPI. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/api-definition/introduction/what-is-an-api-definition). \ No newline at end of file diff --git a/fern/products/grpc-def/pages/schemas/anyof.mdx b/fern/products/grpc-def/pages/schemas/anyof.mdx index 04690e099..bd293f9da 100644 --- a/fern/products/grpc-def/pages/schemas/anyof.mdx +++ b/fern/products/grpc-def/pages/schemas/anyof.mdx @@ -1,7 +1,7 @@ --- -title: AnyOf +title: Any Of --- -# AnyOf +How to use the `anyOf` keyword to allow multiple possible schemas in OpenAPI. -How to use the `anyOf` keyword to allow multiple possible schemas in OpenAPI. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/api-definition/introduction/what-is-an-api-definition). \ No newline at end of file diff --git a/fern/products/grpc-def/pages/schemas/enums.mdx b/fern/products/grpc-def/pages/schemas/enums.mdx index c50286ca0..269806428 100644 --- a/fern/products/grpc-def/pages/schemas/enums.mdx +++ b/fern/products/grpc-def/pages/schemas/enums.mdx @@ -2,6 +2,6 @@ title: Enums --- -# Enums +How to use enum types to define a fixed set of values in OpenAPI. -How to define and use enums in your OpenAPI schemas. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/api-definition/introduction/what-is-an-api-definition). \ No newline at end of file diff --git a/fern/products/grpc-def/pages/schemas/inlined-schemas.mdx b/fern/products/grpc-def/pages/schemas/inlined-schemas.mdx index 68f31c620..50d864e10 100644 --- a/fern/products/grpc-def/pages/schemas/inlined-schemas.mdx +++ b/fern/products/grpc-def/pages/schemas/inlined-schemas.mdx @@ -2,6 +2,6 @@ title: Inlined Schemas --- -# Inlined Schemas +How to define schemas inline within your OpenAPI specification. -How to define inlined schemas directly within your OpenAPI definitions. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/api-definition/introduction/what-is-an-api-definition). \ No newline at end of file diff --git a/fern/products/grpc-def/pages/schemas/objects.mdx b/fern/products/grpc-def/pages/schemas/objects.mdx index 3f4225bf2..99c6a6e41 100644 --- a/fern/products/grpc-def/pages/schemas/objects.mdx +++ b/fern/products/grpc-def/pages/schemas/objects.mdx @@ -2,6 +2,6 @@ title: Objects --- -# Objects +How to define object schemas with properties in OpenAPI. -Learn how to define object schemas in OpenAPI, including properties and required fields. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/api-definition/introduction/what-is-an-api-definition). \ No newline at end of file diff --git a/fern/products/grpc-def/pages/schemas/oneof.mdx b/fern/products/grpc-def/pages/schemas/oneof.mdx index 95e26147d..c29355abe 100644 --- a/fern/products/grpc-def/pages/schemas/oneof.mdx +++ b/fern/products/grpc-def/pages/schemas/oneof.mdx @@ -1,7 +1,7 @@ --- -title: OneOf +title: One Of --- -# OneOf +How to use the `oneOf` keyword to define alternative schemas in OpenAPI. -How to use the `oneOf` keyword to define alternative schemas in OpenAPI. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/api-definition/introduction/what-is-an-api-definition). \ No newline at end of file diff --git a/fern/products/grpc-def/pages/schemas/override-type.mdx b/fern/products/grpc-def/pages/schemas/override-type.mdx index acf4791c2..44cac7698 100644 --- a/fern/products/grpc-def/pages/schemas/override-type.mdx +++ b/fern/products/grpc-def/pages/schemas/override-type.mdx @@ -1,7 +1,7 @@ --- -title: Override the Type +title: Override Type --- -# Override the Type +How to override the default type inference for schemas in OpenAPI. -How to override the type of a schema in OpenAPI. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/api-definition/introduction/what-is-an-api-definition). \ No newline at end of file diff --git a/fern/products/grpc-def/pages/security-schemes/multiple-security-schemes.mdx b/fern/products/grpc-def/pages/security-schemes/multiple-security-schemes.mdx index 286d0a352..04a3407ed 100644 --- a/fern/products/grpc-def/pages/security-schemes/multiple-security-schemes.mdx +++ b/fern/products/grpc-def/pages/security-schemes/multiple-security-schemes.mdx @@ -2,6 +2,6 @@ title: Multiple Security Schemes --- -# Multiple Security Schemes +Learn how to define and use multiple security schemes in your OpenAPI definition. -Learn how to define and use multiple security schemes in your OpenAPI definition. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/api-definition/introduction/what-is-an-api-definition). \ No newline at end of file diff --git a/fern/products/grpc-def/pages/security-schemes/overriding-security-scheme.mdx b/fern/products/grpc-def/pages/security-schemes/overriding-security-scheme.mdx index cf38307fc..905a45251 100644 --- a/fern/products/grpc-def/pages/security-schemes/overriding-security-scheme.mdx +++ b/fern/products/grpc-def/pages/security-schemes/overriding-security-scheme.mdx @@ -1,7 +1,7 @@ --- -title: Overriding the Security Scheme +title: Overriding Security Scheme --- -# Overriding the Security Scheme +How to override security schemes in specific operations or contexts. -How to override the default security scheme in your OpenAPI definition. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/api-definition/introduction/what-is-an-api-definition). \ No newline at end of file diff --git a/fern/products/grpc-def/pages/security-schemes/overview.mdx b/fern/products/grpc-def/pages/security-schemes/overview.mdx index c6be3e7c6..7743f8089 100644 --- a/fern/products/grpc-def/pages/security-schemes/overview.mdx +++ b/fern/products/grpc-def/pages/security-schemes/overview.mdx @@ -2,6 +2,6 @@ title: Security Schemes Overview --- -# Security Schemes Overview +Overview of security schemes and authentication methods in OpenAPI. -An introduction to security schemes in OpenAPI. Learn about authentication and authorization options. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/api-definition/introduction/what-is-an-api-definition). \ No newline at end of file diff --git a/fern/products/grpc-def/pages/servers/multiple-server-urls.mdx b/fern/products/grpc-def/pages/servers/multiple-server-urls.mdx index 4f563e0ef..94ba2c929 100644 --- a/fern/products/grpc-def/pages/servers/multiple-server-urls.mdx +++ b/fern/products/grpc-def/pages/servers/multiple-server-urls.mdx @@ -2,6 +2,6 @@ title: Multiple Server URLs --- -# Multiple Server URLs +How to configure multiple server URLs for different environments. -How to define and use multiple server URLs in your OpenAPI definition. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/api-definition/introduction/what-is-an-api-definition). \ No newline at end of file diff --git a/fern/products/grpc-def/pages/servers/naming-your-servers.mdx b/fern/products/grpc-def/pages/servers/naming-your-servers.mdx index ce65b26b6..fd2a055bb 100644 --- a/fern/products/grpc-def/pages/servers/naming-your-servers.mdx +++ b/fern/products/grpc-def/pages/servers/naming-your-servers.mdx @@ -2,6 +2,6 @@ title: Naming Your Servers --- -# Naming Your Servers +Best practices for naming your server configurations. -Best practices for naming your server URLs in OpenAPI. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/api-definition/introduction/what-is-an-api-definition). \ No newline at end of file diff --git a/fern/products/grpc-def/pages/servers/overriding-servers.mdx b/fern/products/grpc-def/pages/servers/overriding-servers.mdx index 67ab82071..0c5cc5f6f 100644 --- a/fern/products/grpc-def/pages/servers/overriding-servers.mdx +++ b/fern/products/grpc-def/pages/servers/overriding-servers.mdx @@ -1,7 +1,7 @@ --- -title: Overriding the Servers +title: Overriding Servers --- -# Overriding the Servers +How to override server configurations in specific contexts. -How to override the default servers in your OpenAPI definition. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/api-definition/introduction/what-is-an-api-definition). \ No newline at end of file diff --git a/fern/products/grpc-def/pages/servers/overview.mdx b/fern/products/grpc-def/pages/servers/overview.mdx index b45b551c9..761a9d085 100644 --- a/fern/products/grpc-def/pages/servers/overview.mdx +++ b/fern/products/grpc-def/pages/servers/overview.mdx @@ -2,6 +2,6 @@ title: Servers Overview --- -# Servers Overview +Overview of server configuration options in OpenAPI. -Introduction to server objects in OpenAPI. Learn how to define and manage server URLs. \ No newline at end of file +This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/api-definition/introduction/what-is-an-api-definition). \ No newline at end of file diff --git a/fern/products/home/pages/images/product-switcher-askfern-light.png b/fern/products/home/pages/images/product-switcher-askfern-light.png new file mode 100644 index 000000000..3332c1351 Binary files /dev/null and b/fern/products/home/pages/images/product-switcher-askfern-light.png differ diff --git a/fern/products/home/pages/images/product-switcher-docs-light.png b/fern/products/home/pages/images/product-switcher-docs-light.png new file mode 100644 index 000000000..772cef6ca Binary files /dev/null and b/fern/products/home/pages/images/product-switcher-docs-light.png differ diff --git a/fern/products/home/pages/images/product-switcher-home-light.png b/fern/products/home/pages/images/product-switcher-home-light.png new file mode 100644 index 000000000..57c04cabc Binary files /dev/null and b/fern/products/home/pages/images/product-switcher-home-light.png differ diff --git a/fern/products/home/pages/images/product-switcher-sdks-light.png b/fern/products/home/pages/images/product-switcher-sdks-light.png new file mode 100644 index 000000000..d3253e8ac Binary files /dev/null and b/fern/products/home/pages/images/product-switcher-sdks-light.png differ diff --git a/fern/products/home/pages/welcome.mdx b/fern/products/home/pages/welcome.mdx index 0ae962146..148409827 100644 --- a/fern/products/home/pages/welcome.mdx +++ b/fern/products/home/pages/welcome.mdx @@ -6,6 +6,8 @@ hide-toc: true layout: custom --- +import { FernStatusWidget } from "../../../components/FernStatus"; +