replaced deprecated 'excerpt' frontmatter property with 'description' (…

…#3651)
fern-api · May 20, 2024 · 558dffb · 558dffb
1 parent a96ebe0
commit 558dffb
Show file tree

Hide file tree

Showing 37 changed files with 37 additions and 37 deletions.
diff --git a/fern/pages/api-definition/introduction/what-is-an-api-definition.mdx b/fern/pages/api-definition/introduction/what-is-an-api-definition.mdx
@@ -1,6 +1,6 @@
 ---
 title: What is an API Definition?
-excerpt: Describes the contract between the API provider and API consumer
+description: Describes the contract between the API provider and API consumer
 ---
 
 <Info>

diff --git a/fern/pages/docs/components/accordion-groups.mdx b/fern/pages/docs/components/accordion-groups.mdx
@@ -1,6 +1,6 @@
 ---
 title: 'Accordion Groups'
-excerpt: Display expandable/collapsible options that can reveal more information
+description: Display expandable/collapsible options that can reveal more information
 icon: 'table-rows'
 ---
 <AccordionGroup>

diff --git a/fern/pages/docs/components/accordions.mdx b/fern/pages/docs/components/accordions.mdx
@@ -1,6 +1,6 @@
 ---
 title: 'Accordions'
-excerpt: Expand or collapse to reveal more information
+description: Expand or collapse to reveal more information
 icon: 'square-caret-down'
 ---
 

diff --git a/fern/pages/docs/components/asides.mdx b/fern/pages/docs/components/asides.mdx
@@ -1,6 +1,6 @@
 ---
 title: 'Aside'
-excerpt: Push any content inside the Aside component to the right of the page in a sticky container
+description: Push any content inside the Aside component to the right of the page in a sticky container
 icon: 'align-right'
 ---
 

diff --git a/fern/pages/docs/components/callouts.mdx b/fern/pages/docs/components/callouts.mdx
@@ -1,6 +1,6 @@
 ---
 title: 'Callouts'
-excerpt: 'A built-in component to show important information to the reader'
+description: 'A built-in component to show important information to the reader'
 icon: 'circle-exclamation'
 ---
 

diff --git a/fern/pages/docs/components/card-groups.mdx b/fern/pages/docs/components/card-groups.mdx
@@ -1,6 +1,6 @@
 ---
 title: 'Card Groups'
-excerpt: Show cards side by side in a grid format
+description: Show cards side by side in a grid format
 ---
 
 The `CardGroup` component lets you group multiple `Card` components together. It's most often used to put multiple cards on the same column.

diff --git a/fern/pages/docs/components/endpoint-request-snippet.mdx b/fern/pages/docs/components/endpoint-request-snippet.mdx
@@ -1,6 +1,6 @@
 ---
 title: Endpoint Request Snippet
-excerpt: Reference an endpoint request from your API Reference
+description: Reference an endpoint request from your API Reference
 ---
 
 The `EndpointRequestSnippet` component is used to reference an endpoint request from 

diff --git a/fern/pages/docs/components/endpoint-response-snippet.mdx b/fern/pages/docs/components/endpoint-response-snippet.mdx
@@ -1,6 +1,6 @@
 ---
 title: Endpoint Response Snippet
-excerpt: Reference an endpoint response from your API Reference
+description: Reference an endpoint response from your API Reference
 ---
 
 The `EndpointResponseSnippet` component is used to reference an endpoint 

diff --git a/fern/pages/docs/components/frames.mdx b/fern/pages/docs/components/frames.mdx
@@ -1,6 +1,6 @@
 ---
 title: 'Frames'
-excerpt: 'Wrap images in a container with the frame component'
+description: 'Wrap images in a container with the frame component'
 ---
 
 <Frame caption="Beautiful mountains">

diff --git a/fern/pages/docs/components/steps.mdx b/fern/pages/docs/components/steps.mdx
@@ -1,6 +1,6 @@
 ---
 title: Steps
-excerpt: The Steps component helps you display a set of instructions to the user. 
+description: The Steps component helps you display a set of instructions to the user. 
 ---
 
 The `Steps` component is used when you want to display a set of instructions for the user to follow. 

diff --git a/fern/pages/docs/components/tabs.mdx b/fern/pages/docs/components/tabs.mdx
@@ -1,6 +1,6 @@
 ---
 title: 'Tabs'
-excerpts: The Tabs component allows you to display related content in a tabbed view.
+descriptions: The Tabs component allows you to display related content in a tabbed view.
 icon: 'window-restore'
 ---
 

diff --git a/fern/pages/docs/introduction/development.mdx b/fern/pages/docs/introduction/development.mdx
@@ -1,6 +1,6 @@
 ---
 title: 'Development'
-excerpt: 'Preview changes before deploying to production'
+description: 'Preview changes before deploying to production'
 ---
 
 <Info>

diff --git a/fern/pages/docs/introduction/project-structure.mdx b/fern/pages/docs/introduction/project-structure.mdx
@@ -1,6 +1,6 @@
 ---
 title: Project Structure
-excerpt: An overview of the file and folder structure of a Fern Docs project
+description: An overview of the file and folder structure of a Fern Docs project
 ---
 
 This page provides an overview of the file and folder structure of a Fern Docs project. The following structure is recommended for organizing your documentation content, but is customizable to fit your needs.

diff --git a/fern/pages/docs/introduction/quickstart.mdx b/fern/pages/docs/introduction/quickstart.mdx
@@ -1,6 +1,6 @@
 ---
 title: Quickstart
-excerpt: Start building beautiful documentation in under 5 minutes.
+description: Start building beautiful documentation in under 5 minutes.
 ---
 
 <img alt="Docs cascase" src="./docs-cascade.png" />

diff --git a/fern/pages/docs/introduction/showcase.mdx b/fern/pages/docs/introduction/showcase.mdx
@@ -1,6 +1,6 @@
 ---
 title: Showcase
-excerpt: See examples of developer documentation built with Fern
+description: See examples of developer documentation built with Fern
 ---
 
 With Fern, you can build beautiful developer documentation that matches your brand. Fern supports both generating API Reference documentation as well as guides and tutorials.

diff --git a/fern/pages/sdks/features/augment-with-custom-code.mdx b/fern/pages/sdks/features/augment-with-custom-code.mdx
@@ -1,6 +1,6 @@
 ---
 title: Augment with custom code
-excerpt: Extend the generated SDK to provide additional functionality
+description: Extend the generated SDK to provide additional functionality
 ---
 
 <Warning title='Pro Feature'>

diff --git a/fern/pages/sdks/features/auto-pagination.mdx b/fern/pages/sdks/features/auto-pagination.mdx
@@ -1,6 +1,6 @@
 ---
 title: Auto Pagination
-excerpt: Paginate through API responses easily
+description: Paginate through API responses easily
 ---
 
 <Warning title='Pro Feature'>

diff --git a/fern/pages/sdks/features/code-snippets.mdx b/fern/pages/sdks/features/code-snippets.mdx
@@ -1,6 +1,6 @@
 ---
 title: Code Snippets
-excerpt: No longer depend on manually written code snippets
+description: No longer depend on manually written code snippets
 ---
 
 <Warning title='Pro Feature'>

diff --git a/fern/pages/sdks/features/forward-compatibility.mdx b/fern/pages/sdks/features/forward-compatibility.mdx
@@ -1,6 +1,6 @@
 ---
 title: Forward compatibility 
-excerpt: SDKs that are fault-tolerant as your API evolves
+description: SDKs that are fault-tolerant as your API evolves
 ---
 
 Fern SDKs are designed so that you can evolve your API without breaking users on 

diff --git a/fern/pages/sdks/features/idempotency-headers.mdx b/fern/pages/sdks/features/idempotency-headers.mdx
@@ -1,6 +1,6 @@
 ---
 title: Idempotency Headers
-excerpt: SDKs that safely support retrying requests
+description: SDKs that safely support retrying requests
 ---
 
 <Warning title='Pro Feature'>

diff --git a/fern/pages/sdks/features/idiomatic-method-names.mdx b/fern/pages/sdks/features/idiomatic-method-names.mdx
@@ -1,6 +1,6 @@
 ---
 title: Idiomatic Method Names
-excerpt: Fine-tune SDK resources and method names
+description: Fine-tune SDK resources and method names
 ---
 
 Fern allows you to fine-tune your SDK method and group names so that 

diff --git a/fern/pages/sdks/features/integration-tests.mdx b/fern/pages/sdks/features/integration-tests.mdx
@@ -1,6 +1,6 @@
 ---
 title: Integration Tests
-excerpt: Test your SDK against a mock server
+description: Test your SDK against a mock server
 ---
 
 <Warning title='Pro Feature'>

diff --git a/fern/pages/sdks/features/merging-multiple-apis.mdx b/fern/pages/sdks/features/merging-multiple-apis.mdx
@@ -1,6 +1,6 @@
 ---
 title: Merging multiple API specs
-excerpt: Multiple API Definitions. One SDK.
+description: Multiple API Definitions. One SDK.
 ---
 
 <Warning title='Pro Feature'>

diff --git a/fern/pages/sdks/features/multipart-form-data.mdx b/fern/pages/sdks/features/multipart-form-data.mdx
@@ -1,6 +1,6 @@
 ---
 title: Multipart Form Data
-excerpt: SDKs that handle multipart form data
+description: SDKs that handle multipart form data
 ---
 
 Fern generated SDKs natively support uploading files and other media through 

diff --git a/fern/pages/sdks/features/oauth.mdx b/fern/pages/sdks/features/oauth.mdx
@@ -1,6 +1,6 @@
 ---
 title: OAuth
-excerpt: Fern supports OAuth as a first class citizen
+description: Fern supports OAuth as a first class citizen
 ---
 
 <Warning title='Pro Feature'>

diff --git a/fern/pages/sdks/features/pro.mdx b/fern/pages/sdks/features/pro.mdx
@@ -1,6 +1,6 @@
 ---
 title: Pro feature
-excerpt: Schedule a demo to get access
+description: Schedule a demo to get access
 ---
 
 <Warn>

diff --git a/fern/pages/sdks/features/publish-to-registries.mdx b/fern/pages/sdks/features/publish-to-registries.mdx
@@ -1,6 +1,6 @@
 ---
 title: Automated publishing to registries
-excerpt: Fern will automatically publish your SDKs to registries like NPM, PyPI, and Maven
+description: Fern will automatically publish your SDKs to registries like NPM, PyPI, and Maven
 ---
 
 <Warning title='Pro Feature'>

diff --git a/fern/pages/sdks/features/retries-with-backoff.mdx b/fern/pages/sdks/features/retries-with-backoff.mdx
@@ -1,6 +1,6 @@
 ---
 title: Retries with Backoff
-excerpt: Automatically retry failures with exponential backoff
+description: Automatically retry failures with exponential backoff
 ---
 
 <Warning title='Pro Feature'>

diff --git a/fern/pages/sdks/features/schema-validation.mdx b/fern/pages/sdks/features/schema-validation.mdx
@@ -1,6 +1,6 @@
 ---
 title: Schema validation
-excerpt: Fail-fast if the payloads diverge from your schema
+description: Fail-fast if the payloads diverge from your schema
 ---
 
 Often times, your API Definition may drift from your server implementation. 

diff --git a/fern/pages/sdks/features/server-sent-events.mdx b/fern/pages/sdks/features/server-sent-events.mdx
@@ -1,6 +1,6 @@
 ---
 title: Server-Sent Events
-excerpt: Stream JSON data from your server to your client (i.e. chat completions)
+description: Stream JSON data from your server to your client (i.e. chat completions)
 ---
 
 <Warning title='Pro Feature'>

diff --git a/fern/pages/sdks/features/strongly-typed.mdx b/fern/pages/sdks/features/strongly-typed.mdx
@@ -1,6 +1,6 @@
 ---
 title: Strongly Typed
-excerpt: Move fast and break nothing with type safety
+description: Move fast and break nothing with type safety
 ---
 
 Fern generated SDKs are optimized for great autocompletion in 

diff --git a/fern/pages/sdks/features/webhook-signature-verification.mdx b/fern/pages/sdks/features/webhook-signature-verification.mdx
@@ -1,6 +1,6 @@
 ---
 title: Webhook Signature Verification
-excerpt: Verify the signature of incoming webhook requests
+description: Verify the signature of incoming webhook requests
 ---
 
 <Warning title='Pro Feature'>

diff --git a/fern/pages/sdks/features/websockets.mdx b/fern/pages/sdks/features/websockets.mdx
@@ -1,6 +1,6 @@
 ---
 title: WebSockets
-excerpt: Send and receive messages over WebSockets
+description: Send and receive messages over WebSockets
 ---
 
 <Warning title='Pro Feature'>

diff --git a/fern/pages/sdks/getting-started/generate-your-first-sdk.mdx b/fern/pages/sdks/getting-started/generate-your-first-sdk.mdx
@@ -1,6 +1,6 @@
 ---
 title: Generate your first SDK
-excerpt: Use Fern's CLI tool to generate your first SDK.
+description: Use Fern's CLI tool to generate your first SDK.
 ---
 
 <Warning title='Schedule a Demo'>

diff --git a/fern/pages/sdks/introduction/overview.mdx b/fern/pages/sdks/introduction/overview.mdx
@@ -1,6 +1,6 @@
 ---
 title: Overview
-excerpt: Generate SDKs in multiple programming languages
+description: Generate SDKs in multiple programming languages
 ---
 
 Fern supports generating SDKs in several different programming languages. Each 

diff --git a/fern/pages/sdks/publish-sdk/publish-your-sdk.mdx b/fern/pages/sdks/publish-sdk/publish-your-sdk.mdx
@@ -1,6 +1,6 @@
 ---
 title: Publish a public-facing SDK
-excerpt: Use Fern to publish a public-facing SDK
+description: Use Fern to publish a public-facing SDK
 ---
 
 <Frame caption="Merge.dev uses Fern for their SDKs">

diff --git a/fern/pages/welcome.mdx b/fern/pages/welcome.mdx
@@ -1,6 +1,6 @@
 ---
 title: Welcome
-excerpt: Input OpenAPI. Output SDKs and Docs.
+description: Input OpenAPI. Output SDKs and Docs.
 slug: home
 layout: overview
 ---