diff --git a/fern/products/docs/pages/api-references/sdk-snippets.mdx b/fern/products/docs/pages/api-references/sdk-snippets.mdx index f0aa18021..2631bd69c 100644 --- a/fern/products/docs/pages/api-references/sdk-snippets.mdx +++ b/fern/products/docs/pages/api-references/sdk-snippets.mdx @@ -77,6 +77,10 @@ navigation: ``` + + To display different package names for SDK users versus documentation users, [use overrides files](/api-definitions/overview/overrides#separate-overrides-for-sdks-and-docs). + + ### Trigger generation As the final step, trigger your docs generation by running `fern generate --docs` locally or in CI/CD (i.e., GitHub Actions). The SDK snippets will now appear via a drop-down! diff --git a/fern/products/docs/pages/getting-started/project-structure.mdx b/fern/products/docs/pages/getting-started/project-structure.mdx index d4ca8d041..e7690fa7a 100644 --- a/fern/products/docs/pages/getting-started/project-structure.mdx +++ b/fern/products/docs/pages/getting-started/project-structure.mdx @@ -165,6 +165,18 @@ title: Fern's Documentation + + If you're using Fern for both API Reference documentation and SDKs, you'll use both `docs.yml` (the Docs configuration file) and `generators.yml` ([the SDK configuration file](/sdks/overview/github#generatorsyml)) to configure [how SDK code snippets appear](/docs/api-references/sdk-snippets) in your API reference documentation. + + If you're only using Fern for API Reference docs, not SDKs, your `generators.yml` should simply link to your spec: + + ```yaml title="generators.yml" + api: + specs: + - openapi: ../openapi/openapi.json + ``` + + ## `fern.config.json` @@ -177,4 +189,6 @@ The `fern.config.json` file specifies your organization name and the version of "version": "" } ``` - \ No newline at end of file + + +