Skip to content

Add overview content to existing Introduction page #156

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
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
27 changes: 26 additions & 1 deletion fern/products/sdks/introduction.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,33 @@
---
title: SDKs Overview
description: Generate idiomatic SDKs in multiple programming languages
subtitle: Fern generates and publishes idiomatic SDKs your team can focus on building the API.
---

## How it works

At a high level, using Fern to build your SDK involves:

1. **Inputting your API Definition**. Fern takes your API Definition and sets up
a directory (the `fern` folder) containing YAML files that describe your API endpoints,
request/response schemas, authentication, and error handling.
1. **Generating an SDK** in one or multiple languages. Fern SDKs have extensive [built-in
capabilities](/sdks/overview/capabilities) designed to meet your needs.
1. **Adding your custom code and configuration**. Once you have a basic SDK
generated, connect to GitHub, set up publishing credentials, and and
configure other metadata. You can also set up [audience
filtering](/sdks/deep-dives/filter-your-endpoints-audiences), [auto
pagination](/sdks/deep-dives/configure-auto-pagination), and other advanced
capabilities.
1. **Releasing your versioned SDKs** to users via package registries.

When your API changes, simply update your definition and regenerate the SDK to release a new version.

## Get started

After you've installed the Fern CLI and [set up your `fern`
folder](/sdks/overview/quickstart), generate your SDK. Choose from a wide
range of programming languages, each with its own idiomatic SDK generator:

<div className="sdks-homepage">
{/* Dashed Pattern - Left Side */}
<div className="dashed-pattern-left">
Expand Down