Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion fern/products/api-def/ferndef-pages/export-openapi.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Export from Fern Definition to OpenAPI
description: Export your Fern Definition files to OpenAPI using Fern's OpenAPI generator.
description: Export Fern Definition to OpenAPI 3.1 format using the fern export command. Prevent vendor lock-in and convert your API definitions easily.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 [vale] reported by reviewdog 🐶
[FernStyles.Adverbs] Remove 'easily' if it's not important to the meaning of the statement.

---

To prevent lock-in to the Fern Definition format, you can export your API definition to OpenAPI 3.1 at any time [using the `fern export` command](/cli-api-reference/cli-reference/commands#fern-export).
Expand Down
2 changes: 1 addition & 1 deletion fern/products/docs/pages/customization/search.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Search

description: Configure search for your Fern docs using Algolia DocSearch. Filter by versions, endpoints, guides, and changelogs for better user experience.
---

Fern uses [Algolia DocSearch](https://docsearch.algolia.com/) to power search for your documentation.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Publishing your docs
description: Publish your Fern docs to production and staging sites with automated workflows. Set up custom domains and manage deployments easily.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 [vale] reported by reviewdog 🐶
[FernStyles.Adverbs] Remove 'easily' if it's not important to the meaning of the statement.

---

When you are ready for your docs to be publicly accessible, publish them using the Fern CLI. Choose one of the following approaches: publish [only to a production site](#publish-to-production), or [to separate staging and production sites](#publish-to-staging-and-production).
Expand Down
2 changes: 1 addition & 1 deletion fern/products/sdks/custom-code.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Adding custom code
description: Augment your SDK with custom utilities
description: Extend Fern-generated SDKs with custom methods, logic, and dependencies. Use .fernignore to protect your code from being overwritten during regeneration.
---

Fern-generated SDKs are designed to be extended with custom logic, methods, and dependencies. If you want your SDK to do more than just make basic API calls (like combining multiple calls, processing data, adding utilities), you can add custom code that lives in harmony with the generated code.
Expand Down
1 change: 1 addition & 0 deletions fern/products/sdks/fern-folder.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Quickstart
description: Learn how to generate SDKs with Fern. Install the CLI, initialize your project with OpenAPI or Fern Definition, and start building client libraries.
---

Configuring Fern starts with the `fern` folder, the root directory that contains
Expand Down
2 changes: 1 addition & 1 deletion fern/products/sdks/overview/csharp/custom-code.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Adding custom code
description: Augment your .NET SDK with custom utilities
description: Add custom logic and methods to your .NET SDK with Fern. Extend BaseClient, create custom helpers, and use .fernignore effectively.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 [vale] reported by reviewdog 🐶
[FernStyles.Adverbs] Remove 'effectively' if it's not important to the meaning of the statement.

---

This page covers how to add custom logic and methods to your .NET SDK.
Expand Down
2 changes: 1 addition & 1 deletion fern/products/sdks/project-structure.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Project structure
description: An overview of the file and folder structure of a Fern SDKs project
description: Learn how to structure your SDK project with Fern. Set up multi-repo architecture, configure generators.yml, and organize API definitions.
---

Before generating SDKs with Fern, set up the proper GitHub repository structure to house your API definitions and SDK code so it's intuitive for you and your users to access, maintain, and update code.
Expand Down
Loading