diff --git a/fern/pages/docs/building-your-docs/custom-domain.mdx b/fern/pages/docs/building-your-docs/custom-domain.mdx index 867730aff9c..b201169c193 100644 --- a/fern/pages/docs/building-your-docs/custom-domain.mdx +++ b/fern/pages/docs/building-your-docs/custom-domain.mdx @@ -18,7 +18,7 @@ To host your documentation on a subdomain, i.e. `docs.mydomain.com`, you need to -### Step 1: Update the domain in `docs.yml` +### Update the domain in `docs.yml` ```yaml instances: @@ -29,7 +29,7 @@ instances: Merge your changes into `main`. [Here's an example](https://github.com/octoml/fern-config/blob/389b67679953856ba0716537981a6d749635556f/fern/docs.yml#L1-L3 ). -### Step 2: Create a CNAME record +### Create a CNAME record 1. Log in to your domain registrar's dashboard. 2. Navigate to the DNS settings for your domain. @@ -38,13 +38,13 @@ Merge your changes into `main`. [Here's an example](https://github.com/octoml/fe - **Name**: `docs` (or any subdomain you want to use) - **Value**: `cname.vercel-dns.com.` -### Step 3: Reach out to us +### Reach out to us Once you've completed the steps above, reach out via your dedicated Slack channel or [email](mailto:support@buildwithfern.com). You may need to create a TXT record to verify your domain. If you do, we'll provide you with the record to add. -### Step 4: Verify the setup +### Verify the setup Once we've completed the setup on our end, you should be able to access your documentation at `docs.mydomain.com`. SSL will be automatically provisioned for your domain, but it may take a few minutes to propagate globally. @@ -59,7 +59,7 @@ To host your documentation on a subpath, i.e. `mydomain.com/docs`, you need to e -### Step 1: Configure the `url` in `docs.yml` +### Configure the `url` in `docs.yml` Append that subpath to the end of the `url`. This example use `docs` for the subpath, but you can use any word you like, such as `reference` or `developer`. @@ -70,7 +70,7 @@ instances: ``` -### Step 2: Configure the `custom-domain` +### Configure the `custom-domain` Below the `url`, add a `custom-domain` key as shown in the examples below. @@ -84,13 +84,13 @@ instances: [Here's an example.](https://github.com/fern-api/fern/blob/7d8631c6119787a8aaccb4ba49837e73c985db28/fern/docs.yml#L1-L3) -### Step 3: Update the Fern Docs site +### Update the Fern Docs site If you created your Fern Docs site using one of our [Docs Quickstarts](/learn/docs/getting-started/quickstart), push the changes you made to your GitHub repository. This runs a GitHub Action to update the site with your new configuration. If you need to update your Fern Docs site manually, run `fern generate --docs`. -### Step 4: Create DNS records to point at Fern Docs +### Create DNS records to point at Fern Docs This feature is available on the Fern Docs Starter plan and above. Reach out to [sales@buildwithfern.com](mailto:sales@buildwithfern.com) to set up your subscription and obtain DNS records information for your domain registrar. diff --git a/fern/pages/fern-docs/config/sdk-snippets.mdx b/fern/pages/fern-docs/config/sdk-snippets.mdx index ce4a6db7257..039b535a7dd 100644 --- a/fern/pages/fern-docs/config/sdk-snippets.mdx +++ b/fern/pages/fern-docs/config/sdk-snippets.mdx @@ -20,11 +20,11 @@ TypeScript and Python are the SDK code snippet languages supported today. Our de To configure SDK snippets, you'll need to name your SDKs in `generators.yml` and then reference that name in `docs.yml`. In the following example, We'll use `your-organization` as the package name because it is a common practice. For example, Stripe calls their npm package `stripe` and Twilio calls their PyPI package `twilio`. -### Step 1: Add examples to your API definition. +### Add examples to your API definition In order to generate code snippets, Fern needs to read request examples from your API definition. If you're using a Fern Definition, you can follow [these instructions](/learn/api-definition/fern/examples). If you're using an OpenAPI Specification, you can follow [these instructions](https://swagger.io/docs/specification/adding-examples/). -### Step 2: Define a package name for your SDK(s). +### Define a package name for your SDK(s) ```yaml @@ -48,7 +48,7 @@ groups: ``` -### Step 3: Add the package name to your docs configuration. +### Add the package name to your docs configuration ```yaml @@ -68,4 +68,4 @@ Merge.dev is an example of a Fern customer that uses the Snippets API to bring P ## Endpoint request and response snippets -Looking for information on generating API endpoint request and response snippets? See our documentation on [Endpoint Request Snippets](/learn/docs/components/request-snippet) and [Endpoint Response Snippets](/learn/docs/components/response-snippet). \ No newline at end of file +Looking for information on generating API endpoint request and response snippets? See our documentation on [Endpoint Request Snippets](/learn/docs/components/request-snippet) and [Endpoint Response Snippets](/learn/docs/components/response-snippet). diff --git a/fern/pages/sdks/features/publish-to-registries.mdx b/fern/pages/sdks/features/publish-to-registries.mdx index 990e8196668..9586e2539ea 100644 --- a/fern/pages/sdks/features/publish-to-registries.mdx +++ b/fern/pages/sdks/features/publish-to-registries.mdx @@ -13,7 +13,7 @@ that you can easily distribute your SDKs to your users without having to worry about the publishing process. - ### Step 1: Configure your output location + ### Configure your output location In your `generators.yml` you can specify which generators (e.g. Python, Go, TypeScript) you would like to subscribe to. To publish to a registry, you will need to specify the `output` @@ -65,7 +65,7 @@ about the publishing process. - ### Step 2: Run `fern generate` + ### Run `fern generate` Once you have configured your `generators.yml`, you can run `fern generate` to trigger the SDK generation process.